From e1e05ba663cad2b43c1e2ca7200eb6732b9de951 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:08 +0000 Subject: [PATCH 01/40] chore: update docs/dyn/index.md --- docs/dyn/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 533497c145..f13bd7dc07 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -524,6 +524,7 @@ ## dataproc * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/dataproc_v1.html) +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/dataproc_v2.html) ## datastore From c05bd83c57b411dc76368407908e67e8b4a3663e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:09 +0000 Subject: [PATCH 02/40] feat(accesscontextmanager): update the api #### accesscontextmanager:v1 The following keys were deleted: - schemas.GcpUserAccessBinding.properties.restrictedClientApplications (Total Keys: 3) The following keys were added: - resources.folders.methods.lookupConfiguredServicePerimeter (Total Keys: 11) - resources.projects.methods.lookupConfiguredServicePerimeter (Total Keys: 11) - schemas.LookupConfiguredServicePerimeterResponse (Total Keys: 6) --- docs/dyn/accesscontextmanager_v1.folders.html | 111 ++++++++++++++++++ docs/dyn/accesscontextmanager_v1.html | 10 ++ ...1.organizations.gcpUserAccessBindings.html | 32 +---- .../dyn/accesscontextmanager_v1.projects.html | 111 ++++++++++++++++++ .../documents/accesscontextmanager.v1.json | 93 +++++++++++++-- 5 files changed, 319 insertions(+), 38 deletions(-) create mode 100644 docs/dyn/accesscontextmanager_v1.folders.html create mode 100644 docs/dyn/accesscontextmanager_v1.projects.html diff --git a/docs/dyn/accesscontextmanager_v1.folders.html b/docs/dyn/accesscontextmanager_v1.folders.html new file mode 100644 index 0000000000..a2174e48ae --- /dev/null +++ b/docs/dyn/accesscontextmanager_v1.folders.html @@ -0,0 +1,111 @@ + + + +

Access Context Manager API . folders

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookupConfiguredServicePerimeter(resource, x__xgafv=None)

+

Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].

+

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.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/accesscontextmanager_v1.html b/docs/dyn/accesscontextmanager_v1.html index deb517b4ac..8e6c27a84b 100644 --- a/docs/dyn/accesscontextmanager_v1.html +++ b/docs/dyn/accesscontextmanager_v1.html @@ -79,6 +79,11 @@

Instance Methods

Returns the accessPolicies Resource.

+

+ folders() +

+

Returns the folders Resource.

+

operations()

@@ -94,6 +99,11 @@

Instance Methods

Returns the permissions Resource.

+

+ projects() +

+

Returns the projects Resource.

+

services()

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 @@

Method Details

"serviceAccount": "A String", # Immutable. Service account email used to assign policies to a specific service account. If a service account is subject to multiple policies (e.g., if there is a policy for all service accounts in a project and a policy for the service account), the closest (i.e. the most specific) dry-run policy will be used for the dry-run functionality and the closest enforcement policy will be used for the enforcement. "serviceAccountProjectNumber": "A String", # Immutable. Cloud project number used to assign policies to all service accounts owned by the project. }, - "restrictedClientApplications": [ # Optional. Deprecated: Use `scoped_access_settings` instead. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications. - { # An application that accesses Google Cloud APIs. - "clientId": "A String", # The OAuth client ID of the application. - "name": "A String", # The name of the application. Example: "Cloud Console" - }, - ], - "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set. + "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. { # A relationship between access settings and its scope. "activeSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -270,13 +264,7 @@

Method Details

"serviceAccount": "A String", # Immutable. Service account email used to assign policies to a specific service account. If a service account is subject to multiple policies (e.g., if there is a policy for all service accounts in a project and a policy for the service account), the closest (i.e. the most specific) dry-run policy will be used for the dry-run functionality and the closest enforcement policy will be used for the enforcement. "serviceAccountProjectNumber": "A String", # Immutable. Cloud project number used to assign policies to all service accounts owned by the project. }, - "restrictedClientApplications": [ # Optional. Deprecated: Use `scoped_access_settings` instead. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications. - { # An application that accesses Google Cloud APIs. - "clientId": "A String", # The OAuth client ID of the application. - "name": "A String", # The name of the application. Example: "Cloud Console" - }, - ], - "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set. + "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. { # A relationship between access settings and its scope. "activeSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -358,13 +346,7 @@

Method Details

"serviceAccount": "A String", # Immutable. Service account email used to assign policies to a specific service account. If a service account is subject to multiple policies (e.g., if there is a policy for all service accounts in a project and a policy for the service account), the closest (i.e. the most specific) dry-run policy will be used for the dry-run functionality and the closest enforcement policy will be used for the enforcement. "serviceAccountProjectNumber": "A String", # Immutable. Cloud project number used to assign policies to all service accounts owned by the project. }, - "restrictedClientApplications": [ # Optional. Deprecated: Use `scoped_access_settings` instead. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications. - { # An application that accesses Google Cloud APIs. - "clientId": "A String", # The OAuth client ID of the application. - "name": "A String", # The name of the application. Example: "Cloud Console" - }, - ], - "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set. + "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. { # A relationship between access settings and its scope. "activeSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" @@ -453,13 +435,7 @@

Method Details

"serviceAccount": "A String", # Immutable. Service account email used to assign policies to a specific service account. If a service account is subject to multiple policies (e.g., if there is a policy for all service accounts in a project and a policy for the service account), the closest (i.e. the most specific) dry-run policy will be used for the dry-run functionality and the closest enforcement policy will be used for the enforcement. "serviceAccountProjectNumber": "A String", # Immutable. Cloud project number used to assign policies to all service accounts owned by the project. }, - "restrictedClientApplications": [ # Optional. Deprecated: Use `scoped_access_settings` instead. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications. - { # An application that accesses Google Cloud APIs. - "clientId": "A String", # The OAuth client ID of the application. - "name": "A String", # The name of the application. Example: "Cloud Console" - }, - ], - "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set. + "scopedAccessSettings": [ # Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. { # A relationship between access settings and its scope. "activeSettings": { # Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. # Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set. "accessLevels": [ # Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" diff --git a/docs/dyn/accesscontextmanager_v1.projects.html b/docs/dyn/accesscontextmanager_v1.projects.html new file mode 100644 index 0000000000..1e231928b2 --- /dev/null +++ b/docs/dyn/accesscontextmanager_v1.projects.html @@ -0,0 +1,111 @@ + + + +

Access Context Manager API . projects

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ lookupConfiguredServicePerimeter(resource, x__xgafv=None)

+

Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].

+

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.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index efd0003858..4a4672cc49 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1000,6 +1000,35 @@ } } }, +"folders": { +"methods": { +"lookupConfiguredServicePerimeter": { +"description": "Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].", +"flatPath": "v1/folders/{foldersId}:lookupConfiguredServicePerimeter", +"httpMethod": "GET", +"id": "accesscontextmanager.folders.lookupConfiguredServicePerimeter", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "Required. The Resource to resolve (e.g. \"projects/123\", \"folders/456\").", +"location": "path", +"pattern": "^folders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:lookupConfiguredServicePerimeter", +"response": { +"$ref": "LookupConfiguredServicePerimeterResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -1325,6 +1354,35 @@ } } }, +"projects": { +"methods": { +"lookupConfiguredServicePerimeter": { +"description": "Looks up the configured service perimeter for a given resource Format: ['projects/{projectNumber}', 'folders/{folderNumber}'].", +"flatPath": "v1/projects/{projectsId}:lookupConfiguredServicePerimeter", +"httpMethod": "GET", +"id": "accesscontextmanager.projects.lookupConfiguredServicePerimeter", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "Required. The Resource to resolve (e.g. \"projects/123\", \"folders/456\").", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:lookupConfiguredServicePerimeter", +"response": { +"$ref": "LookupConfiguredServicePerimeterResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "services": { "methods": { "get": { @@ -1381,7 +1439,7 @@ } } }, -"revision": "20260819", +"revision": "20260827", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -2033,16 +2091,8 @@ "$ref": "Principal", "description": "Optional. Immutable. The principal that is subject to the access policies in this policy binding." }, -"restrictedClientApplications": { -"deprecated": true, -"description": "Optional. Deprecated: Use `scoped_access_settings` instead. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications.", -"items": { -"$ref": "Application" -}, -"type": "array" -}, "scopedAccessSettings": { -"description": "Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set.", +"description": "Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications.", "items": { "$ref": "ScopedAccessSettings" }, @@ -2338,6 +2388,29 @@ }, "type": "object" }, +"LookupConfiguredServicePerimeterResponse": { +"description": "A configured service perimeter returned by Access Context Manager.", +"id": "LookupConfiguredServicePerimeterResponse", +"properties": { +"restrictedResource": { +"description": "The resource (e.g. \"projects/123\", \"folders/456\") that directly owns/is restricted by the enforced perimeter.", +"type": "string" +}, +"restrictedResourceDryRun": { +"description": "The resource (e.g. \"projects/123\", \"folders/456\") that directly owns/is restricted by the dry-run perimeter.", +"type": "string" +}, +"servicePerimeter": { +"description": "Fully qualified name of the configured enforced perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no enforced perimeter applies.", +"type": "string" +}, +"servicePerimeterDryRun": { +"description": "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.", +"type": "string" +} +}, +"type": "object" +}, "MethodSelector": { "description": "An allowed method or permission of a service specified in ApiOperation.", "id": "MethodSelector", From 277ad485b5c45dbadab8ea32d7b66a23b19e6204 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:09 +0000 Subject: [PATCH 03/40] feat(admin): update the api #### admin:directory_v1 The following keys were added: - schemas.ExpirationDetails (Total Keys: 4) - schemas.RoleAssignment.properties.expirationDetails.$ref (Total Keys: 1) --- .../admin_directory_v1.roleAssignments.html | 12 ++++++++++++ .../documents/admin.directory_v1.json | 18 +++++++++++++++++- 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/dyn/admin_directory_v1.roleAssignments.html b/docs/dyn/admin_directory_v1.roleAssignments.html index ce1421450b..4655b10664 100644 --- a/docs/dyn/admin_directory_v1.roleAssignments.html +++ b/docs/dyn/admin_directory_v1.roleAssignments.html @@ -132,6 +132,9 @@

Method Details

"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`). "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. "etag": "A String", # ETag of the resource. + "expirationDetails": { # Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached. # Optional. Details regarding the expiration of this role assignment. + "expireTime": "A String", # The specific timestamp when the role assignment expires. + }, "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. "roleAssignmentId": "A String", # ID of this roleAssignment. @@ -154,6 +157,9 @@

Method Details

"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`). "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. "etag": "A String", # ETag of the resource. + "expirationDetails": { # Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached. # Optional. Details regarding the expiration of this role assignment. + "expireTime": "A String", # The specific timestamp when the role assignment expires. + }, "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. "roleAssignmentId": "A String", # ID of this roleAssignment. @@ -174,6 +180,9 @@

Method Details

"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`). "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. "etag": "A String", # ETag of the resource. + "expirationDetails": { # Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached. # Optional. Details regarding the expiration of this role assignment. + "expireTime": "A String", # The specific timestamp when the role assignment expires. + }, "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. "roleAssignmentId": "A String", # ID of this roleAssignment. @@ -209,6 +218,9 @@

Method Details

"assigneeType": "A String", # Output only. The type of the assignee (`USER` or `GROUP`). "condition": "A String", # Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. "etag": "A String", # ETag of the resource. + "expirationDetails": { # Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached. # Optional. Details regarding the expiration of this role assignment. + "expireTime": "A String", # The specific timestamp when the role assignment expires. + }, "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. "roleAssignmentId": "A String", # ID of this roleAssignment. diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 1280a8cd6b..d1094e72bf 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4729,7 +4729,7 @@ } } }, -"revision": "20260729", +"revision": "20260902", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6570,6 +6570,18 @@ false "properties": {}, "type": "object" }, +"ExpirationDetails": { +"description": "Details regarding the expiration of this role assignment. Used to automatically revoke access when the time limit is reached.", +"id": "ExpirationDetails", +"properties": { +"expireTime": { +"description": "The specific timestamp when the role assignment expires.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "ExternalId": { "description": "External identifier used to link and identify this group across external directory systems.", "id": "ExternalId", @@ -7686,6 +7698,10 @@ false "description": "ETag of the resource.", "type": "string" }, +"expirationDetails": { +"$ref": "ExpirationDetails", +"description": "Optional. Details regarding the expiration of this role assignment." +}, "kind": { "default": "admin#directory#roleAssignment", "description": "The type of the API resource. This is always `admin#directory#roleAssignment`.", From 603d8daca1a63cce1c0c7cacb69da0a40eab9060 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:10 +0000 Subject: [PATCH 04/40] feat(alloydb): update the api #### alloydb:v1 The following keys were added: - schemas.DnsAutomationInfo (Total Keys: 6) - schemas.Instance.properties.pscInstanceInfo (Total Keys: 2) - schemas.PscAutoConnectionConfig.properties.dnsAutomationInfos (Total Keys: 3) - schemas.PscAutoConnectionConfig.properties.serviceConnectionPolicy (Total Keys: 4) - schemas.PscInstanceConfig.properties.pscAutoConnectionPolicyState.type (Total Keys: 1) - schemas.PscInstanceConfig.properties.pscAutoDnsState.type (Total Keys: 1) - schemas.PscInstanceInfo (Total Keys: 11) #### alloydb:v1alpha The following keys were added: - schemas.DnsAutomationInfo (Total Keys: 6) - schemas.PscAutoConnectionConfig.properties.dnsAutomationInfos (Total Keys: 3) - schemas.PscAutoConnectionConfig.properties.serviceConnectionPolicy (Total Keys: 4) #### alloydb:v1beta The following keys were added: - schemas.DnsAutomationInfo (Total Keys: 6) - schemas.PscAutoConnectionConfig.properties.dnsAutomationInfos (Total Keys: 3) - schemas.PscAutoConnectionConfig.properties.serviceConnectionPolicy (Total Keys: 4) --- ...projects.locations.clusters.instances.html | 90 ++++++++++++++ ...projects.locations.clusters.instances.html | 40 ++++++ ...projects.locations.clusters.instances.html | 40 ++++++ .../discovery_cache/documents/alloydb.v1.json | 116 +++++++++++++++++- .../documents/alloydb.v1alpha.json | 53 +++++++- .../documents/alloydb.v1beta.json | 53 +++++++- 6 files changed, 389 insertions(+), 3 deletions(-) diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 85890f2ab4..b00f4c5113 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -205,15 +205,25 @@

Method Details

"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", ], + "pscAutoConnectionPolicyState": "A String", # Optional. Configuration for setting up PSC auto connection for the instance. "pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation. { # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. "consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], + "pscAutoDnsState": "A String", # Optional. Configuration for setting up PSC auto DNS for the instance. "pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog "pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. { # Configuration for setting up a PSC interface to enable outbound connectivity. @@ -222,6 +232,14 @@

Method Details

], "serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` }, + "pscInstanceInfo": { # Information about the Private Service Connect (PSC) for the instance. # Output only. Information about the Private Service Connect (PSC) for the instance. + "effectivePscAutoConnectionPolicy": True or False, # Output only. Indicates if the PSC auto connection policy is enabled for the instance. For older instances, this will be off by default, but for newer instances, this will be auto-enabled. + "effectivePscAutoDnsEnabled": True or False, # Output only. The effective state of the PSC auto DNS for the instance. + "pscAutoDnsNames": [ # Output only. Specifies the auto DNS names for the instance. + "A String", + ], + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + }, "publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. "queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid. @@ -367,15 +385,25 @@

Method Details

"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", ], + "pscAutoConnectionPolicyState": "A String", # Optional. Configuration for setting up PSC auto connection for the instance. "pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation. { # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. "consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], + "pscAutoDnsState": "A String", # Optional. Configuration for setting up PSC auto DNS for the instance. "pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog "pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. { # Configuration for setting up a PSC interface to enable outbound connectivity. @@ -384,6 +412,14 @@

Method Details

], "serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` }, + "pscInstanceInfo": { # Information about the Private Service Connect (PSC) for the instance. # Output only. Information about the Private Service Connect (PSC) for the instance. + "effectivePscAutoConnectionPolicy": True or False, # Output only. Indicates if the PSC auto connection policy is enabled for the instance. For older instances, this will be off by default, but for newer instances, this will be auto-enabled. + "effectivePscAutoDnsEnabled": True or False, # Output only. The effective state of the PSC auto DNS for the instance. + "pscAutoDnsNames": [ # Output only. Specifies the auto DNS names for the instance. + "A String", + ], + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + }, "publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. "queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid. @@ -620,15 +656,25 @@

Method Details

"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", ], + "pscAutoConnectionPolicyState": "A String", # Optional. Configuration for setting up PSC auto connection for the instance. "pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation. { # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. "consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], + "pscAutoDnsState": "A String", # Optional. Configuration for setting up PSC auto DNS for the instance. "pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog "pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. { # Configuration for setting up a PSC interface to enable outbound connectivity. @@ -637,6 +683,14 @@

Method Details

], "serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` }, + "pscInstanceInfo": { # Information about the Private Service Connect (PSC) for the instance. # Output only. Information about the Private Service Connect (PSC) for the instance. + "effectivePscAutoConnectionPolicy": True or False, # Output only. Indicates if the PSC auto connection policy is enabled for the instance. For older instances, this will be off by default, but for newer instances, this will be auto-enabled. + "effectivePscAutoDnsEnabled": True or False, # Output only. The effective state of the PSC auto DNS for the instance. + "pscAutoDnsNames": [ # Output only. Specifies the auto DNS names for the instance. + "A String", + ], + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + }, "publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. "queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid. @@ -829,15 +883,25 @@

Method Details

"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", ], + "pscAutoConnectionPolicyState": "A String", # Optional. Configuration for setting up PSC auto connection for the instance. "pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation. { # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. "consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], + "pscAutoDnsState": "A String", # Optional. Configuration for setting up PSC auto DNS for the instance. "pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog "pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. { # Configuration for setting up a PSC interface to enable outbound connectivity. @@ -846,6 +910,14 @@

Method Details

], "serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` }, + "pscInstanceInfo": { # Information about the Private Service Connect (PSC) for the instance. # Output only. Information about the Private Service Connect (PSC) for the instance. + "effectivePscAutoConnectionPolicy": True or False, # Output only. Indicates if the PSC auto connection policy is enabled for the instance. For older instances, this will be off by default, but for newer instances, this will be auto-enabled. + "effectivePscAutoDnsEnabled": True or False, # Output only. The effective state of the PSC auto DNS for the instance. + "pscAutoDnsNames": [ # Output only. Specifies the auto DNS names for the instance. + "A String", + ], + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + }, "publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. "queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid. @@ -980,15 +1052,25 @@

Method Details

"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance. "A String", ], + "pscAutoConnectionPolicyState": "A String", # Optional. Configuration for setting up PSC auto connection for the instance. "pscAutoConnections": [ # Optional. Configurations for setting up PSC service automation. { # Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance. "consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], + "pscAutoDnsState": "A String", # Optional. Configuration for setting up PSC auto DNS for the instance. "pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog "pscInterfaceConfigs": [ # Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface. { # Configuration for setting up a PSC interface to enable outbound connectivity. @@ -997,6 +1079,14 @@

Method Details

], "serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/` }, + "pscInstanceInfo": { # Information about the Private Service Connect (PSC) for the instance. # Output only. Information about the Private Service Connect (PSC) for the instance. + "effectivePscAutoConnectionPolicy": True or False, # Output only. Indicates if the PSC auto connection policy is enabled for the instance. For older instances, this will be off by default, but for newer instances, this will be auto-enabled. + "effectivePscAutoDnsEnabled": True or False, # Output only. The effective state of the PSC auto DNS for the instance. + "pscAutoDnsNames": [ # Output only. Specifies the auto DNS names for the instance. + "A String", + ], + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + }, "publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application. "queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights. "queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 4946fe3a3b..306eac0c44 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -220,7 +220,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -426,7 +434,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -723,7 +739,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -981,7 +1005,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -1176,7 +1208,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index 6891e9a400..e446569263 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -220,7 +220,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -425,7 +433,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -721,7 +737,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -978,7 +1002,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], @@ -1172,7 +1204,15 @@

Method Details

"consumerNetwork": "A String", # The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project. "consumerNetworkStatus": "A String", # Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy. "consumerProject": "A String", # The consumer project to which the PSC service automation endpoint will be created. + "dnsAutomationInfos": [ # Output only. List of DNS automation info for the PSC auto connection. + { # DnsAutomationInfo contains information about the DNS automation for the instance. + "fullyQualifiedDomainName": "A String", # Output only. The fully qualified domain name of the instance for DNS automation. Example: "...alloydb.goog.". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information. + "state": "A String", # Output only. The state of the DNS automation. + }, + ], "ipAddress": "A String", # Output only. The IP address of the PSC service automation endpoint. + "serviceConnectionPolicy": "A String", # Output only. The PSC service connection policy name. The format is "projects//regions//serviceConnectionPolicies/" + "serviceConnectionPolicyCreationState": "A String", # Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly. "status": "A String", # Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion. }, ], diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 269581a670..c7b1a3b9a0 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260818", +"revision": "20260826", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2931,6 +2931,39 @@ false }, "type": "object" }, +"DnsAutomationInfo": { +"description": "DnsAutomationInfo contains information about the DNS automation for the instance.", +"id": "DnsAutomationInfo", +"properties": { +"fullyQualifiedDomainName": { +"description": "Output only. The fully qualified domain name of the instance for DNS automation. Example: \"...alloydb.goog.\". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the DNS automation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING_CREATE", +"ACTIVE", +"PENDING_DELETE", +"CREATE_FAILED", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"DNS record creation is pending.", +"DNS record is active.", +"DNS record deletion is pending.", +"DNS record creation failed.", +"DNS record deletion failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -3367,6 +3400,11 @@ false "$ref": "PscInstanceConfig", "description": "Optional. The configuration for Private Service Connect (PSC) for the instance." }, +"pscInstanceInfo": { +"$ref": "PscInstanceInfo", +"description": "Output only. Information about the Private Service Connect (PSC) for the instance.", +"readOnly": true +}, "publicIpAddress": { "description": "Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.", "readOnly": true, @@ -4023,11 +4061,29 @@ false "description": "The consumer project to which the PSC service automation endpoint will be created.", "type": "string" }, +"dnsAutomationInfos": { +"description": "Output only. List of DNS automation info for the PSC auto connection.", +"items": { +"$ref": "DnsAutomationInfo" +}, +"readOnly": true, +"type": "array" +}, "ipAddress": { "description": "Output only. The IP address of the PSC service automation endpoint.", "readOnly": true, "type": "string" }, +"serviceConnectionPolicy": { +"description": "Output only. The PSC service connection policy name. The format is \"projects//regions//serviceConnectionPolicies/\"", +"readOnly": true, +"type": "string" +}, +"serviceConnectionPolicyCreationState": { +"description": "Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly.", +"readOnly": true, +"type": "string" +}, "status": { "description": "Output only. The status of the PSC service automation connection. Possible values: \"STATE_UNSPECIFIED\" - An invalid state as the default case. \"ACTIVE\" - The connection has been created successfully. \"FAILED\" - The connection is not functional since some resources on the connection fail to be created. \"CREATING\" - The connection is being created. \"DELETING\" - The connection is being deleted. \"CREATE_REPAIRING\" - The connection is being repaired to complete creation. \"DELETE_REPAIRING\" - The connection is being repaired to complete deletion.", "readOnly": true, @@ -4064,6 +4120,20 @@ false }, "type": "array" }, +"pscAutoConnectionPolicyState": { +"description": "Optional. Configuration for setting up PSC auto connection for the instance.", +"enum": [ +"PSC_AUTO_CONNECTION_POLICY_STATE_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"The state is unspecified. For old instances, this means the PSC auto connection is disabled. For new instances, this means the PSC auto connection is enabled by default.", +"Enables the PSC auto connection for the instance.", +"Disables the PSC auto connection for the instance." +], +"type": "string" +}, "pscAutoConnections": { "description": "Optional. Configurations for setting up PSC service automation.", "items": { @@ -4071,6 +4141,20 @@ false }, "type": "array" }, +"pscAutoDnsState": { +"description": "Optional. Configuration for setting up PSC auto DNS for the instance.", +"enum": [ +"PSC_AUTO_DNS_STATE_UNSPECIFIED", +"PSC_AUTO_DNS_STATE_ENABLED", +"PSC_AUTO_DNS_STATE_DISABLED" +], +"enumDescriptions": [ +"The state is unspecified. For old instances, this means the PSC auto DNS is disabled. For new instances, this means the PSC auto DNS is enabled by default. Use `effective_psc_auto_dns_enabled` to check the effective state of the PSC auto DNS.", +"Enables the PSC auto DNS for the instance.", +"Disables the PSC auto DNS for the instance." +], +"type": "string" +}, "pscDnsName": { "description": "Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog", "readOnly": true, @@ -4091,6 +4175,36 @@ false }, "type": "object" }, +"PscInstanceInfo": { +"description": "Information about the Private Service Connect (PSC) for the instance.", +"id": "PscInstanceInfo", +"properties": { +"effectivePscAutoConnectionPolicy": { +"description": "Output only. Indicates if the PSC auto connection policy is enabled for the instance. For older instances, this will be off by default, but for newer instances, this will be auto-enabled.", +"readOnly": true, +"type": "boolean" +}, +"effectivePscAutoDnsEnabled": { +"description": "Output only. The effective state of the PSC auto DNS for the instance.", +"readOnly": true, +"type": "boolean" +}, +"pscAutoDnsNames": { +"description": "Output only. Specifies the auto DNS names for the instance.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"serviceConnectionPolicy": { +"description": "Output only. The PSC service connection policy name. The format is \"projects//regions//serviceConnectionPolicies/\"", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "PscInterfaceConfig": { "description": "Configuration for setting up a PSC interface to enable outbound connectivity.", "id": "PscInterfaceConfig", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 574790d604..37bc7f9b89 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -2086,7 +2086,7 @@ } } }, -"revision": "20260818", +"revision": "20260826", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3229,6 +3229,39 @@ false }, "type": "object" }, +"DnsAutomationInfo": { +"description": "DnsAutomationInfo contains information about the DNS automation for the instance.", +"id": "DnsAutomationInfo", +"properties": { +"fullyQualifiedDomainName": { +"description": "Output only. The fully qualified domain name of the instance for DNS automation. Example: \"...alloydb.goog.\". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the DNS automation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING_CREATE", +"ACTIVE", +"PENDING_DELETE", +"CREATE_FAILED", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"DNS record creation is pending.", +"DNS record is active.", +"DNS record deletion is pending.", +"DNS record creation failed.", +"DNS record deletion failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -4542,11 +4575,29 @@ false "description": "The consumer project to which the PSC service automation endpoint will be created.", "type": "string" }, +"dnsAutomationInfos": { +"description": "Output only. List of DNS automation info for the PSC auto connection.", +"items": { +"$ref": "DnsAutomationInfo" +}, +"readOnly": true, +"type": "array" +}, "ipAddress": { "description": "Output only. The IP address of the PSC service automation endpoint.", "readOnly": true, "type": "string" }, +"serviceConnectionPolicy": { +"description": "Output only. The PSC service connection policy name. The format is \"projects//regions//serviceConnectionPolicies/\"", +"readOnly": true, +"type": "string" +}, +"serviceConnectionPolicyCreationState": { +"description": "Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly.", +"readOnly": true, +"type": "string" +}, "status": { "description": "Output only. The status of the PSC service automation connection. Possible values: \"STATE_UNSPECIFIED\" - An invalid state as the default case. \"ACTIVE\" - The connection has been created successfully. \"FAILED\" - The connection is not functional since some resources on the connection fail to be created. \"CREATING\" - The connection is being created. \"DELETING\" - The connection is being deleted. \"CREATE_REPAIRING\" - The connection is being repaired to complete creation. \"DELETE_REPAIRING\" - The connection is being repaired to complete deletion.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index f2891befc3..d3e4649098 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -2083,7 +2083,7 @@ } } }, -"revision": "20260818", +"revision": "20260826", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3210,6 +3210,39 @@ false }, "type": "object" }, +"DnsAutomationInfo": { +"description": "DnsAutomationInfo contains information about the DNS automation for the instance.", +"id": "DnsAutomationInfo", +"properties": { +"fullyQualifiedDomainName": { +"description": "Output only. The fully qualified domain name of the instance for DNS automation. Example: \"...alloydb.goog.\". Note: The AUDIT directive is intentionally omitted because this field contains sensitive network topology information.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the DNS automation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING_CREATE", +"ACTIVE", +"PENDING_DELETE", +"CREATE_FAILED", +"DELETE_FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"DNS record creation is pending.", +"DNS record is active.", +"DNS record deletion is pending.", +"DNS record creation failed.", +"DNS record deletion failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -4518,11 +4551,29 @@ false "description": "The consumer project to which the PSC service automation endpoint will be created.", "type": "string" }, +"dnsAutomationInfos": { +"description": "Output only. List of DNS automation info for the PSC auto connection.", +"items": { +"$ref": "DnsAutomationInfo" +}, +"readOnly": true, +"type": "array" +}, "ipAddress": { "description": "Output only. The IP address of the PSC service automation endpoint.", "readOnly": true, "type": "string" }, +"serviceConnectionPolicy": { +"description": "Output only. The PSC service connection policy name. The format is \"projects//regions//serviceConnectionPolicies/\"", +"readOnly": true, +"type": "string" +}, +"serviceConnectionPolicyCreationState": { +"description": "Output only. The creation state or result of the connection policy. Possible values include: - `ACTIVE`: The policy was created successfully. - `PERMISSION_DENIED`: Sufficient permissions were not provided. Note that this field is an unstructured output and customers should not rely on the specific string value or error message directly.", +"readOnly": true, +"type": "string" +}, "status": { "description": "Output only. The status of the PSC service automation connection. Possible values: \"STATE_UNSPECIFIED\" - An invalid state as the default case. \"ACTIVE\" - The connection has been created successfully. \"FAILED\" - The connection is not functional since some resources on the connection fail to be created. \"CREATING\" - The connection is being created. \"DELETING\" - The connection is being deleted. \"CREATE_REPAIRING\" - The connection is being repaired to complete creation. \"DELETE_REPAIRING\" - The connection is being repaired to complete deletion.", "readOnly": true, From 57208553add39495a53e7fb83342dcc569e6cf98 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:10 +0000 Subject: [PATCH 05/40] feat(androidpublisher): update the api #### androidpublisher:v3 The following keys were added: - schemas.ExternalContentLinkDetails (Total Keys: 5) - schemas.ExternalTransaction.properties.externalContentLinkDetails.$ref (Total Keys: 1) - schemas.OneTimeProductGameRewardOffer (Total Keys: 4) - schemas.OneTimeProductOffer.properties.gameRewardOffer.$ref (Total Keys: 1) --- ...roidpublisher_v3.externaltransactions.html | 20 ++++++ ...netimeproducts.purchaseOptions.offers.html | 24 ++++++++ .../documents/androidpublisher.v3.json | 61 ++++++++++++++++++- 3 files changed, 104 insertions(+), 1 deletion(-) diff --git a/docs/dyn/androidpublisher_v3.externaltransactions.html b/docs/dyn/androidpublisher_v3.externaltransactions.html index d0c652c3ee..d0194e90da 100644 --- a/docs/dyn/androidpublisher_v3.externaltransactions.html +++ b/docs/dyn/androidpublisher_v3.externaltransactions.html @@ -111,6 +111,11 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalContentLinkDetails": { # Reporting details unique to the external content link program. # Optional. Details necessary to accurately report external content link transactions. + "externalAppCategory": "A String", # Optional. The category of the downlaoded app. This must match the category provided in Play Console during the external app verification process. Only required for app installs. + "installedAppPackage": "A String", # Optional. The package name of the app downloaded through this transaction. Only required for app installs. + "linkType": "A String", # Required. The type content being reported by this transaction. + }, "externalOfferDetails": { # Reporting details unique to the external offers program. # Optional. Details necessary to accurately report external offers transactions. "appDownloadEventExternalTransactionId": "A String", # Optional. The external transaction id associated with the app download event through an external link. Required when reporting transactions made in externally installed apps. "installedAppCategory": "A String", # Optional. The category of the downloaded app though this transaction. This must match the category provided in Play Console during the external app verification process. Only required for app downloads. @@ -170,6 +175,11 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalContentLinkDetails": { # Reporting details unique to the external content link program. # Optional. Details necessary to accurately report external content link transactions. + "externalAppCategory": "A String", # Optional. The category of the downlaoded app. This must match the category provided in Play Console during the external app verification process. Only required for app installs. + "installedAppPackage": "A String", # Optional. The package name of the app downloaded through this transaction. Only required for app installs. + "linkType": "A String", # Required. The type content being reported by this transaction. + }, "externalOfferDetails": { # Reporting details unique to the external offers program. # Optional. Details necessary to accurately report external offers transactions. "appDownloadEventExternalTransactionId": "A String", # Optional. The external transaction id associated with the app download event through an external link. Required when reporting transactions made in externally installed apps. "installedAppCategory": "A String", # Optional. The category of the downloaded app though this transaction. This must match the category provided in Play Console during the external app verification process. Only required for app downloads. @@ -235,6 +245,11 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalContentLinkDetails": { # Reporting details unique to the external content link program. # Optional. Details necessary to accurately report external content link transactions. + "externalAppCategory": "A String", # Optional. The category of the downlaoded app. This must match the category provided in Play Console during the external app verification process. Only required for app installs. + "installedAppPackage": "A String", # Optional. The package name of the app downloaded through this transaction. Only required for app installs. + "linkType": "A String", # Required. The type content being reported by this transaction. + }, "externalOfferDetails": { # Reporting details unique to the external offers program. # Optional. Details necessary to accurately report external offers transactions. "appDownloadEventExternalTransactionId": "A String", # Optional. The external transaction id associated with the app download event through an external link. Required when reporting transactions made in externally installed apps. "installedAppCategory": "A String", # Optional. The category of the downloaded app though this transaction. This must match the category provided in Play Console during the external app verification process. Only required for app downloads. @@ -316,6 +331,11 @@

Method Details

"currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. }, + "externalContentLinkDetails": { # Reporting details unique to the external content link program. # Optional. Details necessary to accurately report external content link transactions. + "externalAppCategory": "A String", # Optional. The category of the downlaoded app. This must match the category provided in Play Console during the external app verification process. Only required for app installs. + "installedAppPackage": "A String", # Optional. The package name of the app downloaded through this transaction. Only required for app installs. + "linkType": "A String", # Required. The type content being reported by this transaction. + }, "externalOfferDetails": { # Reporting details unique to the external offers program. # Optional. Details necessary to accurately report external offers transactions. "appDownloadEventExternalTransactionId": "A String", # Optional. The external transaction id associated with the app download event through an external link. Required when reporting transactions made in externally installed apps. "installedAppCategory": "A String", # Optional. The category of the downloaded app though this transaction. This must match the category provided in Play Console during the external app verification process. Only required for app downloads. diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html index 91f272ac57..ba6b96f754 100644 --- a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html +++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html @@ -139,6 +139,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -243,6 +246,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -303,6 +309,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -361,6 +370,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -454,6 +466,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -526,6 +541,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -601,6 +619,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. @@ -664,6 +685,9 @@

Method Details

"redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. "startTime": "A String", # Time when the offer will start being available. }, + "gameRewardOffer": { # Configuration specific to game reward offers. # A game reward offer. + "redemptionLimit": "A String", # Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive. + }, "offerId": "A String", # Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters. "offerTags": [ # Optional. List of up to 20 custom tags specified for this offer, and returned to the app through the billing library. { # Represents a custom tag specified for a product offer. diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 6c8f0d7d1d..d7e36fa672 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -5970,7 +5970,7 @@ } } }, -"revision": "20260825", +"revision": "20260901", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -8857,6 +8857,45 @@ }, "type": "object" }, +"ExternalContentLinkDetails": { +"description": "Reporting details unique to the external content link program.", +"id": "ExternalContentLinkDetails", +"properties": { +"externalAppCategory": { +"description": "Optional. The category of the downlaoded app. This must match the category provided in Play Console during the external app verification process. Only required for app installs.", +"enum": [ +"EXTERNAL_CONTENT_APP_CATEGORY_UNSPECIFIED", +"APP", +"GAME" +], +"enumDescriptions": [ +"Unspecified, do not use.", +"The app is classified under the app category.", +"The app is classified under the game category." +], +"type": "string" +}, +"installedAppPackage": { +"description": "Optional. The package name of the app downloaded through this transaction. Only required for app installs.", +"type": "string" +}, +"linkType": { +"description": "Required. The type content being reported by this transaction.", +"enum": [ +"EXTERNAL_CONTENT_LINK_TYPE_UNSPECIFIED", +"LINK_TO_DIGITAL_CONTENT_OFFER", +"LINK_TO_APP_DOWNLOAD" +], +"enumDescriptions": [ +"Unspecified, do not use.", +"An offer to purchase digital content.", +"An app install." +], +"type": "string" +} +}, +"type": "object" +}, "ExternalOfferDetails": { "description": "Reporting details unique to the external offers program.", "id": "ExternalOfferDetails", @@ -8941,6 +8980,10 @@ "description": "Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction.", "readOnly": true }, +"externalContentLinkDetails": { +"$ref": "ExternalContentLinkDetails", +"description": "Optional. Details necessary to accurately report external content link transactions." +}, "externalOfferDetails": { "$ref": "ExternalOfferDetails", "description": "Optional. Details necessary to accurately report external offers transactions." @@ -10792,6 +10835,18 @@ false }, "type": "object" }, +"OneTimeProductGameRewardOffer": { +"description": "Configuration specific to game reward offers.", +"id": "OneTimeProductGameRewardOffer", +"properties": { +"redemptionLimit": { +"description": "Optional. The number of times this offer can be redeemed. If unset or set to 0, allows for unlimited offer redemptions. Otherwise must be a number between 1 and 50 inclusive.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "OneTimeProductListing": { "description": "Regional store listing for a one-time product.", "id": "OneTimeProductListing", @@ -10819,6 +10874,10 @@ false "$ref": "OneTimeProductDiscountedOffer", "description": "A discounted offer." }, +"gameRewardOffer": { +"$ref": "OneTimeProductGameRewardOffer", +"description": "A game reward offer." +}, "offerId": { "description": "Required. Immutable. The ID of this product offer. Must be unique within the purchase option. It must start with a number or lower-case letter, and can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-). The maximum length is 63 characters.", "type": "string" From a1e71537ce3b8b99e763cfab1d3d9834bf48c9c6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:10 +0000 Subject: [PATCH 06/40] feat(apigateway): update the api #### apigateway:v1 The following keys were added: - schemas.ApigatewayGateway.properties.effectiveStreamingMode (Total Keys: 2) - schemas.ApigatewayGateway.properties.streamingMode.type (Total Keys: 1) #### apigateway:v1beta The following keys were added: - schemas.ApigatewayGateway.properties.effectiveStreamingMode (Total Keys: 2) - schemas.ApigatewayGateway.properties.streamingMode.type (Total Keys: 1) --- ...ateway_v1.projects.locations.gateways.html | 8 +++++ ...ay_v1beta.projects.locations.gateways.html | 8 +++++ .../documents/apigateway.v1.json | 29 ++++++++++++++++++- .../documents/apigateway.v1beta.json | 29 ++++++++++++++++++- 4 files changed, 72 insertions(+), 2 deletions(-) diff --git a/docs/dyn/apigateway_v1.projects.locations.gateways.html b/docs/dyn/apigateway_v1.projects.locations.gateways.html index a963a22255..32f31eda94 100644 --- a/docs/dyn/apigateway_v1.projects.locations.gateways.html +++ b/docs/dyn/apigateway_v1.projects.locations.gateways.html @@ -124,11 +124,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. } @@ -216,11 +218,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. } @@ -298,11 +302,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. }, ], @@ -341,11 +347,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. } diff --git a/docs/dyn/apigateway_v1beta.projects.locations.gateways.html b/docs/dyn/apigateway_v1beta.projects.locations.gateways.html index 057bc34b28..a34fe7ef5e 100644 --- a/docs/dyn/apigateway_v1beta.projects.locations.gateways.html +++ b/docs/dyn/apigateway_v1beta.projects.locations.gateways.html @@ -124,11 +124,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. } @@ -216,11 +218,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. } @@ -298,11 +302,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. }, ], @@ -341,11 +347,13 @@

Method Details

"createTime": "A String", # Output only. Created time. "defaultHostname": "A String", # Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. "displayName": "A String", # Optional. Display name. + "effectiveStreamingMode": "A String", # Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, "name": "A String", # Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} "state": "A String", # Output only. The current state of the Gateway. + "streamingMode": "A String", # Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with. "updateTime": "A String", # Output only. Updated time. } diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index 907310aaff..8bcf021f87 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1094,7 +1094,7 @@ } } }, -"revision": "20260422", +"revision": "20260902", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1412,6 +1412,21 @@ "description": "Optional. Display name.", "type": "string" }, +"effectiveStreamingMode": { +"description": "Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming.", +"enum": [ +"EFFECTIVE_STREAMING_MODE_UNSPECIFIED", +"EFFECTIVE_STREAMING_MODE_DISABLED", +"EFFECTIVE_STREAMING_MODE_ENABLED" +], +"enumDescriptions": [ +"The service has not resolved a mode. Every gateway returned by `GetGateway` and `ListGateways` carries a resolved mode, so this value should not be returned under normal circumstances.", +"The gateway does not support response streaming.", +"The gateway supports response streaming." +], +"readOnly": true, +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -1445,6 +1460,18 @@ "readOnly": true, "type": "string" }, +"streamingMode": { +"description": "Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with.", +"enum": [ +"STREAMING_MODE_UNSPECIFIED", +"STREAMING_MODE_ENABLED" +], +"enumDescriptions": [ +"The service selects the streaming mode.", +"Streaming is enabled. The gateway supports response streaming: server-sent events, HTTP chunked transfer, WebSockets, and gRPC/HTTP2 bidirectional streaming." +], +"type": "string" +}, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json index 870b0ce6f9..8666ba95a4 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -1094,7 +1094,7 @@ } } }, -"revision": "20260422", +"revision": "20260902", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { @@ -1428,6 +1428,21 @@ "description": "Optional. Display name.", "type": "string" }, +"effectiveStreamingMode": { +"description": "Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from `streaming_mode`, the referenced API Config, and the platform default at the time. Read this rather than `streaming_mode` to determine whether a gateway supports response streaming.", +"enum": [ +"EFFECTIVE_STREAMING_MODE_UNSPECIFIED", +"EFFECTIVE_STREAMING_MODE_DISABLED", +"EFFECTIVE_STREAMING_MODE_ENABLED" +], +"enumDescriptions": [ +"The service has not resolved a mode. Every gateway returned by `GetGateway` and `ListGateways` carries a resolved mode, so this value should not be returned under normal circumstances.", +"The gateway does not support response streaming.", +"The gateway supports response streaming." +], +"readOnly": true, +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -1461,6 +1476,18 @@ "readOnly": true, "type": "string" }, +"streamingMode": { +"description": "Optional. Immutable. Requests response streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read `effective_streaming_mode` for the mode the gateway is served with.", +"enum": [ +"STREAMING_MODE_UNSPECIFIED", +"STREAMING_MODE_ENABLED" +], +"enumDescriptions": [ +"The service selects the streaming mode.", +"Streaming is enabled. The gateway supports response streaming: server-sent events, HTTP chunked transfer, WebSockets, and gRPC/HTTP2 bidirectional streaming." +], +"type": "string" +}, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", From 3e3c1828cafa66a1484b2d454ec7487efa328fbe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:10 +0000 Subject: [PATCH 07/40] feat(apigee): update the api #### apigee:v1 The following keys were added: - resources.organizations.methods.getMcpServerConfig (Total Keys: 11) - schemas.GoogleCloudApigeeV1McpServerConfig (Total Keys: 7) --- docs/dyn/apigee_v1.organizations.html | 26 ++++++++ .../discovery_cache/documents/apigee.v1.json | 60 ++++++++++++++++++- 2 files changed, 85 insertions(+), 1 deletion(-) diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index a9fd0b6027..5c173d0497 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -237,6 +237,9 @@

Instance Methods

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 @@

Method Details

} +
+ 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. }
@@ -2872,6 +3043,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. @@ -2933,6 +3176,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. @@ -3211,6 +3464,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 }, @@ -4110,6 +4364,7 @@

Method Details

}, ], }, + "updateTime": "A String", # Output only. Timestamp when the app version was last updated. } @@ -4381,6 +4636,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. @@ -4442,6 +4769,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. @@ -4720,6 +5057,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 }, @@ -5619,6 +5957,7 @@

Method Details

}, ], }, + "updateTime": "A String", # Output only. Timestamp when the app version was last updated. }, ], "nextPageToken": "A String", # A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. @@ -5639,6 +5978,2827 @@

Method Details

+
+ 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. }
@@ -2960,6 +3131,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. @@ -3021,6 +3264,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. @@ -3343,6 +3596,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 }, @@ -4242,6 +4496,7 @@

Method Details

}, ], }, + "updateTime": "A String", # Output only. Timestamp when the app version was last updated. } @@ -4513,6 +4768,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. @@ -4574,6 +4901,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. @@ -4896,6 +5233,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 }, @@ -5795,6 +6133,7 @@

Method Details

}, ], }, + "updateTime": "A String", # Output only. Timestamp when the app version was last updated. }, ], "nextPageToken": "A String", # A token that can be sent as ListAppVersionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages. @@ -5815,6 +6154,2915 @@

Method Details

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

+

organizations()

@@ -94,6 +99,16 @@

Instance Methods

Returns the services Resource.

+

+ tasks() +

+

Returns the tasks Resource.

+ +

+ v1() +

+

Returns the v1 Resource.

+

close()

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

+

+ pushNotificationConfigs() +

+

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.

+

queues()

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.

+

+ get(name, x__xgafv=None)

+

Gets the latest 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 Automation Date: 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 Automation Date: 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 Automation Date: 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, 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.

aggregated_next(previous_request, previous_response)

@@ -108,7 +108,7 @@

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

list_next(previous_request, previous_response)

@@ -121,7 +121,7 @@

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

list_next(previous_request, previous_response)

@@ -1399,7 +1399,7 @@

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 Automation Date: 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 Automation Date: 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

get(name, x__xgafv=None)

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

get(name, x__xgafv=None)

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).
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index cc623f7b49..049cceca57 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.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.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html index 04fb8dfd08..525cba62cc 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.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_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index 650205f1ff..80b2d0c0ca 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -219,6 +219,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. @@ -338,7 +339,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. @@ -509,6 +510,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. @@ -628,7 +630,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. @@ -798,6 +800,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. @@ -917,7 +920,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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html index 7d973fa692..742ddb0cec 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html @@ -168,6 +168,7 @@

Method Details

"additionalSystemInstruction": "A String", # Optional. Additional system instruction that will be added to the default system instruction. }, }, + "knowledgeCatalogEnabled": True or False, # Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. @@ -227,6 +228,7 @@

Method Details

"additionalSystemInstruction": "A String", # Optional. Additional system instruction that will be added to the default system instruction. }, }, + "knowledgeCatalogEnabled": True or False, # Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. @@ -310,6 +312,7 @@

Method Details

"additionalSystemInstruction": "A String", # Optional. Additional system instruction that will be added to the default system instruction. }, }, + "knowledgeCatalogEnabled": True or False, # Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. @@ -379,6 +382,7 @@

Method Details

"additionalSystemInstruction": "A String", # Optional. Additional system instruction that will be added to the default system instruction. }, }, + "knowledgeCatalogEnabled": True or False, # Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. @@ -456,6 +460,7 @@

Method Details

"additionalSystemInstruction": "A String", # Optional. Additional system instruction that will be added to the default system instruction. }, }, + "knowledgeCatalogEnabled": True or False, # Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. @@ -515,6 +520,7 @@

Method Details

"additionalSystemInstruction": "A String", # Optional. Additional system instruction that will be added to the default system instruction. }, }, + "knowledgeCatalogEnabled": True or False, # Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 449cbf6df0..b96c4b324f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -227,7 +227,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. @@ -423,7 +423,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. @@ -643,7 +643,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. @@ -787,7 +787,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. @@ -913,7 +913,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. @@ -1051,7 +1051,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. @@ -1189,7 +1189,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_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index 658eecf3bb..e0b777d21d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -219,6 +219,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. @@ -338,7 +339,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. @@ -509,6 +510,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. @@ -628,7 +630,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. @@ -798,6 +800,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. @@ -917,7 +920,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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index 35aa8d37c4..087bd17cf7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -219,6 +219,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. @@ -338,7 +339,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. @@ -509,6 +510,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. @@ -628,7 +630,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. @@ -798,6 +800,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. @@ -917,7 +920,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. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 4fda527dba..67bf2619d7 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -159,6 +159,9 @@

Instance Methods

get(name, x__xgafv=None)

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.

trainCustomModel(dataStore, body=None, x__xgafv=None)

Trains a custom model.

@@ -640,6 +646,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.
@@ -1219,6 +1260,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_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
index 7351ac45de..6115925cbe 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
@@ -208,7 +208,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. @@ -395,7 +395,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. @@ -558,7 +558,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. @@ -693,7 +693,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. @@ -810,7 +810,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. @@ -939,7 +939,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. @@ -1068,7 +1068,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_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index f77e14ca61..0c5e2b6321 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -154,6 +154,9 @@

Instance Methods

get(name, x__xgafv=None)

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.

@@ -166,6 +169,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() @@ -632,6 +638,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.
@@ -1211,4 +1252,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).
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index a00b4e90e2..189d3cc329 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -663,6 +663,69 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"getIamPolicy": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:getIamPolicy", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"setIamPolicy": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}:setIamPolicy", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "updateDataConnector": { "description": "Updates a DataConnector.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector", @@ -1004,6 +1067,39 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"getIamPolicy": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:getIamPolicy", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "getSiteSearchEngine": { "description": "Gets the SiteSearchEngine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine", @@ -1110,6 +1206,36 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"setIamPolicy": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:setIamPolicy", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "trainCustomModel": { "description": "Trains a custom model.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", @@ -6158,6 +6284,39 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"getIamPolicy": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:getIamPolicy", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "getSiteSearchEngine": { "description": "Gets the SiteSearchEngine.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine", @@ -6263,6 +6422,36 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +}, +"setIamPolicy": { +"description": "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.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:setIamPolicy", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] } }, "resources": { @@ -9742,7 +9931,7 @@ } } }, -"revision": "20260823", +"revision": "20260831", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -16772,7 +16961,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { @@ -19760,6 +19949,10 @@ false "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, +"searchAddonSpec": { +"$ref": "GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec", +"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests." +}, "searchAsYouTypeSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." @@ -20373,6 +20566,25 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec": { +"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.", +"id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAddonSpec", +"properties": { +"disableGenerativeAnswerAddOn": { +"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", +"type": "boolean" +}, +"disableKpiPersonalizationAddOn": { +"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", +"type": "boolean" +}, +"disableSemanticAddOn": { +"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": { "description": "Specification for search as you type in search requests.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", @@ -22768,6 +22980,23 @@ false "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig", "properties": { +"complianceLevel": { +"description": "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.", +"enum": [ +"COMPLIANCE_LEVEL_UNSPECIFIED", +"COMPLIANCE_LEVEL_FEDRAMP_HIGH", +"COMPLIANCE_LEVEL_IL4", +"COMPLIANCE_LEVEL_IL5" +], +"enumDescriptions": [ +"The project has no Assured Workloads compliance level, or reports one that this API version does not model.", +"FedRAMP High compliance level.", +"Impact Level 4 (IL4) compliance level.", +"Impact Level 5 (IL5) compliance level." +], +"readOnly": true, +"type": "string" +}, "customerType": { "description": "Customer type.", "enum": [ @@ -23074,7 +23303,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "readOnly": true, "type": "object" }, @@ -23145,6 +23374,10 @@ false ], "type": "string" }, +"searchAddonSpec": { +"$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec", +"description": "Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests." +}, "sourceAdminDisplayNameEnabled": { "description": "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.", "type": "boolean" @@ -23305,6 +23538,25 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec": { +"description": "SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.", +"id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsSearchAddonSpec", +"properties": { +"generativeAnswerAddOnDisabled": { +"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", +"type": "boolean" +}, +"kpiPersonalizationAddOnDisabled": { +"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", +"type": "boolean" +}, +"semanticAddOnDisabled": { +"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -27506,7 +27758,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { @@ -33090,7 +33342,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 613b1a4b6b..661b7ee7c3 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -13647,7 +13647,7 @@ } } }, -"revision": "20260823", +"revision": "20260831", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -16496,7 +16496,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { @@ -21435,6 +21435,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig", "description": "Optional. Configuration for the generation of the assistant response." }, +"knowledgeCatalogEnabled": { +"description": "Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data.", +"type": "boolean" +}, "name": { "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" @@ -26136,7 +26140,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { @@ -35187,6 +35191,23 @@ false "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigCustomerProvidedConfig", "properties": { +"complianceLevel": { +"description": "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.", +"enum": [ +"COMPLIANCE_LEVEL_UNSPECIFIED", +"COMPLIANCE_LEVEL_FEDRAMP_HIGH", +"COMPLIANCE_LEVEL_IL4", +"COMPLIANCE_LEVEL_IL5" +], +"enumDescriptions": [ +"The project has no Assured Workloads compliance level, or reports one that this API version does not model.", +"FedRAMP High compliance level.", +"Impact Level 4 (IL4) compliance level.", +"Impact Level 5 (IL5) compliance level." +], +"readOnly": true, +"type": "string" +}, "customerType": { "description": "Customer type.", "enum": [ @@ -35541,7 +35562,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "readOnly": true, "type": "object" }, @@ -37212,7 +37233,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 84c9d23521..88e4a7ef5f 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -868,6 +868,39 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"getIamPolicy": { +"description": "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.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:getIamPolicy", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "getSiteSearchEngine": { "description": "Gets the SiteSearchEngine.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine", @@ -974,6 +1007,36 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"setIamPolicy": { +"description": "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.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:setIamPolicy", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "trainCustomModel": { "description": "Trains a custom model.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", @@ -5531,6 +5594,39 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"getIamPolicy": { +"description": "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.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:getIamPolicy", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "getSiteSearchEngine": { "description": "Gets the SiteSearchEngine.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine", @@ -5636,6 +5732,36 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +}, +"setIamPolicy": { +"description": "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.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:setIamPolicy", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] } }, "resources": { @@ -9554,7 +9680,7 @@ } } }, -"revision": "20260823", +"revision": "20260831", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -12403,7 +12529,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { @@ -18670,7 +18796,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { @@ -27865,7 +27991,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `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`", "type": "object" }, "industryVertical": { From c3f3b25c233b76cc91ea88d3f3324a1d3cc6fe72 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:15 +0000 Subject: [PATCH 21/40] feat(dlp): update the api #### dlp:v2 The following keys were deleted: - schemas.GooglePrivacyDlpV2ContentPolicy.properties.inspectTemplate (Total Keys: 2) - schemas.GooglePrivacyDlpV2PolicyRule.properties.returnVerdict (Total Keys: 2) The following keys were added: - schemas.GooglePrivacyDlpV2ConversationMessage.properties.content.deprecated (Total Keys: 1) - schemas.GooglePrivacyDlpV2ConversationMessage.properties.messageParts (Total Keys: 2) - schemas.GooglePrivacyDlpV2MessagePart (Total Keys: 3) --- docs/dyn/dlp_v2.projects.content.html | 35 +- .../dlp_v2.projects.locations.content.html | 35 +- ...v2.projects.locations.contentPolicies.html | 1768 +---------------- .../dlp_v2.projects.locations.dlpJobs.html | 7 +- ...dlp_v2.projects.locations.jobTriggers.html | 7 +- .../discovery_cache/documents/dlp.v2.json | 43 +- 6 files changed, 188 insertions(+), 1707 deletions(-) diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 7b6a281edd..4df8c1e74e 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -1270,7 +1270,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -1379,7 +1384,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -2571,7 +2581,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -3085,7 +3100,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -4050,7 +4070,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 8e2bc6080c..95814feafd 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -1270,7 +1270,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -1379,7 +1384,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -2571,7 +2581,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -3085,7 +3100,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, @@ -4050,7 +4070,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, diff --git a/docs/dyn/dlp_v2.projects.locations.contentPolicies.html b/docs/dyn/dlp_v2.projects.locations.contentPolicies.html index 3c8997b2ef..f4f0bf9940 100644 --- a/docs/dyn/dlp_v2.projects.locations.contentPolicies.html +++ b/docs/dyn/dlp_v2.projects.locations.contentPolicies.html @@ -394,268 +394,6 @@

Method Details

}, ], }, - "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. - "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. - "description": "A String", # Short description (max 256 chars). - "displayName": "A String", # Display name (max 256 chars). - "inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process. - "contentOptions": [ # Deprecated and unused. - "A String", - ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. - { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - "fileLabelInfoType": { # Configuration for a custom infoType that detects file labels. # File label to detect. - "googleDriveLabel": { # Google Drive labels published by Google. # Google Drive labels published by Google. - "labelFieldsToMatch": [ # The field values of the Google Drive label to match. - { # The field values of the Google Drive label to match. - "id": "A String", # The identifier of the Label Field. - "value": "A String", # The value of the Label Field to match. - }, - ], - "labelId": "A String", # The [label ID](https://developers.google.com/workspace/drive/labels/guides/overview) of the Google Drive label. - }, - "sensitivityLabel": { # Sensitivity labels published by Microsoft. # Sensitivity labels published by Microsoft. - "guid": "A String", # The GUID of the sensitivity label. - }, - }, - "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. - "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair to detect in the metadata. - "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. - "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. - }, - "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "storedType": { # A reference to a StoredInfoType to use with scanning. # Loads an existing `StoredInfoType` resource. - "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. - "name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. - }, - "surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing. - }, - }, - ], - "excludeInfoTypes": True or False, # When true, excludes type information of the findings. This is not used for data profiling. - "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling. - "infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "limits": { # Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. # Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values. - "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. - { # Max findings configuration per infoType, per content item or long running DlpJob. - "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "maxFindings": 42, # Max findings limit for the given infoType. - }, - ], - "maxFindingsPerItem": 42, # Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value. - "maxFindingsPerRequest": 42, # Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://docs.cloud.google.com/sensitive-data-protection/docs/likelihood). - "minLikelihoodPerInfoType": [ # Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood. - { # Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request. - "infoType": { # Type of information detected by the API. # Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. - }, - ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. - { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. - "infoTypes": [ # List of infoTypes this rule set is applied to. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. - { # A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. - "adjustmentRule": { # Rule that specifies conditions when a certain infoType's finding details should be adjusted. # Adjustment rule. - "adjustByImageFindings": { # AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image. # AdjustmentRule condition for image findings. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - }, - ], - }, - "name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. - }, "loggingConfigs": [ # Optional. Log the actions taken by the content policy to external systems. { # A single logging configuration. "logToBigQuery": { # Configuration for logging content policy actions to BigQuery. # Optional. Log the actions taken to a BigQuery table. @@ -685,7 +423,6 @@

Method Details

}, }, ], - "returnVerdict": "A String", # If set, the verdict will be returned to the user. Deprecated: Use `action` instead. }, ], "unsupportedFileType": { # A possible action to take when applying a content policy. # Optional. Action to take if the content is an unsupported file type. @@ -987,268 +724,6 @@

Method Details

}, ], }, - "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. - "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. - "description": "A String", # Short description (max 256 chars). - "displayName": "A String", # Display name (max 256 chars). - "inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process. - "contentOptions": [ # Deprecated and unused. - "A String", - ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. - { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - "fileLabelInfoType": { # Configuration for a custom infoType that detects file labels. # File label to detect. - "googleDriveLabel": { # Google Drive labels published by Google. # Google Drive labels published by Google. - "labelFieldsToMatch": [ # The field values of the Google Drive label to match. - { # The field values of the Google Drive label to match. - "id": "A String", # The identifier of the Label Field. - "value": "A String", # The value of the Label Field to match. - }, - ], - "labelId": "A String", # The [label ID](https://developers.google.com/workspace/drive/labels/guides/overview) of the Google Drive label. - }, - "sensitivityLabel": { # Sensitivity labels published by Microsoft. # Sensitivity labels published by Microsoft. - "guid": "A String", # The GUID of the sensitivity label. - }, - }, - "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. - "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair to detect in the metadata. - "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. - "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. - }, - "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "storedType": { # A reference to a StoredInfoType to use with scanning. # Loads an existing `StoredInfoType` resource. - "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. - "name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. - }, - "surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing. - }, - }, - ], - "excludeInfoTypes": True or False, # When true, excludes type information of the findings. This is not used for data profiling. - "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling. - "infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "limits": { # Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. # Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values. - "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. - { # Max findings configuration per infoType, per content item or long running DlpJob. - "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "maxFindings": 42, # Max findings limit for the given infoType. - }, - ], - "maxFindingsPerItem": 42, # Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value. - "maxFindingsPerRequest": 42, # Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://docs.cloud.google.com/sensitive-data-protection/docs/likelihood). - "minLikelihoodPerInfoType": [ # Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood. - { # Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request. - "infoType": { # Type of information detected by the API. # Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. - }, - ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. - { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. - "infoTypes": [ # List of infoTypes this rule set is applied to. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. - { # A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. - "adjustmentRule": { # Rule that specifies conditions when a certain infoType's finding details should be adjusted. # Adjustment rule. - "adjustByImageFindings": { # AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image. # AdjustmentRule condition for image findings. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - }, - ], - }, - "name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. - }, "loggingConfigs": [ # Optional. Log the actions taken by the content policy to external systems. { # A single logging configuration. "logToBigQuery": { # Configuration for logging content policy actions to BigQuery. # Optional. Log the actions taken to a BigQuery table. @@ -1278,7 +753,6 @@

Method Details

}, }, ], - "returnVerdict": "A String", # If set, the verdict will be returned to the user. Deprecated: Use `action` instead. }, ], "unsupportedFileType": { # A possible action to take when applying a content policy. # Optional. Action to take if the content is an unsupported file type. @@ -1489,381 +963,119 @@

Method Details

}, "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - }, - ], - }, - "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. - "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. - "description": "A String", # Short description (max 256 chars). - "displayName": "A String", # Display name (max 256 chars). - "inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process. - "contentOptions": [ # Deprecated and unused. - "A String", - ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. - { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - "fileLabelInfoType": { # Configuration for a custom infoType that detects file labels. # File label to detect. - "googleDriveLabel": { # Google Drive labels published by Google. # Google Drive labels published by Google. - "labelFieldsToMatch": [ # The field values of the Google Drive label to match. - { # The field values of the Google Drive label to match. - "id": "A String", # The identifier of the Label Field. - "value": "A String", # The value of the Label Field to match. - }, - ], - "labelId": "A String", # The [label ID](https://developers.google.com/workspace/drive/labels/guides/overview) of the Google Drive label. - }, - "sensitivityLabel": { # Sensitivity labels published by Microsoft. # Sensitivity labels published by Microsoft. - "guid": "A String", # The GUID of the sensitivity label. - }, - }, - "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. - "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair to detect in the metadata. - "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. - "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. - }, - "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "storedType": { # A reference to a StoredInfoType to use with scanning. # Loads an existing `StoredInfoType` resource. - "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. - "name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. - }, - "surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing. - }, - }, - ], - "excludeInfoTypes": True or False, # When true, excludes type information of the findings. This is not used for data profiling. - "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling. - "infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "limits": { # Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. # Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values. - "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. - { # Max findings configuration per infoType, per content item or long running DlpJob. - "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "maxFindings": 42, # Max findings limit for the given infoType. - }, - ], - "maxFindingsPerItem": 42, # Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value. - "maxFindingsPerRequest": 42, # Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://docs.cloud.google.com/sensitive-data-protection/docs/likelihood). - "minLikelihoodPerInfoType": [ # Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood. - { # Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request. - "infoType": { # Type of information detected by the API. # Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. - }, - ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. - { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. - "infoTypes": [ # List of infoTypes this rule set is applied to. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. - { # A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. - "adjustmentRule": { # Rule that specifies conditions when a certain infoType's finding details should be adjusted. # Adjustment rule. - "adjustByImageFindings": { # AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image. # AdjustmentRule condition for image findings. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. }, }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. + "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. + { # Type of information detected by the API. + "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. + "score": "A String", # The sensitivity score applied to the resource. }, + "version": "A String", # Optional version name for this InfoType. }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. + ], + "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. + }, + "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. + "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. + { # Type of information detected by the API. + "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. + "score": "A String", # The sensitivity score applied to the resource. }, - ], + "version": "A String", # Optional version name for this InfoType. + }, + ], + "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. + "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. + }, + "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. + "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. + "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. + }, + }, + "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. + "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. + "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. + "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, + "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. + "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] + "A String", ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. }, }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. + "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. 42, ], "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. "windowAfter": 42, # Number of characters after the finding to consider. "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). }, }, + "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. + "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. + "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. + }, + "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. + }, + "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. + }, + }, + "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. + { # Type of information detected by the API. + "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. + "score": "A String", # The sensitivity score applied to the resource. + }, + "version": "A String", # Optional version name for this InfoType. + }, + ], + }, + "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. + "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. + { # Type of information detected by the API. + "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. + "score": "A String", # The sensitivity score applied to the resource. + }, + "version": "A String", # Optional version name for this InfoType. + }, + ], + }, + "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. + "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. + "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. + 42, + ], + "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. + }, }, - ], - }, - ], - }, - "name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. + "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. + "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. + "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. + 42, + ], + "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. + }, + "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. + "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. + "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. + }, + "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + "windowAfter": 42, # Number of characters after the finding to consider. + "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). + }, + }, + }, + ], + }, + ], }, "loggingConfigs": [ # Optional. Log the actions taken by the content policy to external systems. { # A single logging configuration. @@ -1894,7 +1106,6 @@

Method Details

}, }, ], - "returnVerdict": "A String", # If set, the verdict will be returned to the user. Deprecated: Use `action` instead. }, ], "unsupportedFileType": { # A possible action to take when applying a content policy. # Optional. Action to take if the content is an unsupported file type. @@ -2205,268 +1416,6 @@

Method Details

}, ], }, - "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. - "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. - "description": "A String", # Short description (max 256 chars). - "displayName": "A String", # Display name (max 256 chars). - "inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process. - "contentOptions": [ # Deprecated and unused. - "A String", - ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. - { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - "fileLabelInfoType": { # Configuration for a custom infoType that detects file labels. # File label to detect. - "googleDriveLabel": { # Google Drive labels published by Google. # Google Drive labels published by Google. - "labelFieldsToMatch": [ # The field values of the Google Drive label to match. - { # The field values of the Google Drive label to match. - "id": "A String", # The identifier of the Label Field. - "value": "A String", # The value of the Label Field to match. - }, - ], - "labelId": "A String", # The [label ID](https://developers.google.com/workspace/drive/labels/guides/overview) of the Google Drive label. - }, - "sensitivityLabel": { # Sensitivity labels published by Microsoft. # Sensitivity labels published by Microsoft. - "guid": "A String", # The GUID of the sensitivity label. - }, - }, - "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. - "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair to detect in the metadata. - "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. - "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. - }, - "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "storedType": { # A reference to a StoredInfoType to use with scanning. # Loads an existing `StoredInfoType` resource. - "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. - "name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. - }, - "surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing. - }, - }, - ], - "excludeInfoTypes": True or False, # When true, excludes type information of the findings. This is not used for data profiling. - "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling. - "infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "limits": { # Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. # Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values. - "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. - { # Max findings configuration per infoType, per content item or long running DlpJob. - "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "maxFindings": 42, # Max findings limit for the given infoType. - }, - ], - "maxFindingsPerItem": 42, # Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value. - "maxFindingsPerRequest": 42, # Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://docs.cloud.google.com/sensitive-data-protection/docs/likelihood). - "minLikelihoodPerInfoType": [ # Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood. - { # Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request. - "infoType": { # Type of information detected by the API. # Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. - }, - ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. - { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. - "infoTypes": [ # List of infoTypes this rule set is applied to. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. - { # A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. - "adjustmentRule": { # Rule that specifies conditions when a certain infoType's finding details should be adjusted. # Adjustment rule. - "adjustByImageFindings": { # AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image. # AdjustmentRule condition for image findings. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - }, - ], - }, - "name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. - }, "loggingConfigs": [ # Optional. Log the actions taken by the content policy to external systems. { # A single logging configuration. "logToBigQuery": { # Configuration for logging content policy actions to BigQuery. # Optional. Log the actions taken to a BigQuery table. @@ -2496,7 +1445,6 @@

Method Details

}, }, ], - "returnVerdict": "A String", # If set, the verdict will be returned to the user. Deprecated: Use `action` instead. }, ], "unsupportedFileType": { # A possible action to take when applying a content policy. # Optional. Action to take if the content is an unsupported file type. @@ -2813,270 +1761,8 @@

Method Details

}, }, ], - }, - ], - }, - "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. - "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. - "description": "A String", # Short description (max 256 chars). - "displayName": "A String", # Display name (max 256 chars). - "inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process. - "contentOptions": [ # Deprecated and unused. - "A String", - ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. - { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - "fileLabelInfoType": { # Configuration for a custom infoType that detects file labels. # File label to detect. - "googleDriveLabel": { # Google Drive labels published by Google. # Google Drive labels published by Google. - "labelFieldsToMatch": [ # The field values of the Google Drive label to match. - { # The field values of the Google Drive label to match. - "id": "A String", # The identifier of the Label Field. - "value": "A String", # The value of the Label Field to match. - }, - ], - "labelId": "A String", # The [label ID](https://developers.google.com/workspace/drive/labels/guides/overview) of the Google Drive label. - }, - "sensitivityLabel": { # Sensitivity labels published by Microsoft. # Sensitivity labels published by Microsoft. - "guid": "A String", # The GUID of the sensitivity label. - }, - }, - "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. - "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair to detect in the metadata. - "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. - "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. - }, - "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "storedType": { # A reference to a StoredInfoType to use with scanning. # Loads an existing `StoredInfoType` resource. - "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. - "name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. - }, - "surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing. - }, - }, - ], - "excludeInfoTypes": True or False, # When true, excludes type information of the findings. This is not used for data profiling. - "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling. - "infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "limits": { # Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. # Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values. - "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. - { # Max findings configuration per infoType, per content item or long running DlpJob. - "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "maxFindings": 42, # Max findings limit for the given infoType. - }, - ], - "maxFindingsPerItem": 42, # Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value. - "maxFindingsPerRequest": 42, # Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://docs.cloud.google.com/sensitive-data-protection/docs/likelihood). - "minLikelihoodPerInfoType": [ # Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood. - { # Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request. - "infoType": { # Type of information detected by the API. # Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. - }, - ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. - { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. - "infoTypes": [ # List of infoTypes this rule set is applied to. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. - { # A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. - "adjustmentRule": { # Rule that specifies conditions when a certain infoType's finding details should be adjusted. # Adjustment rule. - "adjustByImageFindings": { # AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image. # AdjustmentRule condition for image findings. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - }, - ], - }, - "name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. + }, + ], }, "loggingConfigs": [ # Optional. Log the actions taken by the content policy to external systems. { # A single logging configuration. @@ -3107,7 +1793,6 @@

Method Details

}, }, ], - "returnVerdict": "A String", # If set, the verdict will be returned to the user. Deprecated: Use `action` instead. }, ], "unsupportedFileType": { # A possible action to take when applying a content policy. # Optional. Action to take if the content is an unsupported file type. @@ -3409,268 +2094,6 @@

Method Details

}, ], }, - "inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://docs.cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead. - "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. - "createTime": "A String", # Output only. The creation timestamp of an inspectTemplate. - "description": "A String", # Short description (max 256 chars). - "displayName": "A String", # Display name (max 256 chars). - "inspectConfig": { # Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. # The core content of the template. Configuration of the scanning process. - "contentOptions": [ # Deprecated and unused. - "A String", - ], - "customInfoTypes": [ # CustomInfoTypes provided by the user. See https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes to learn more. - { # Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question. - "detectionRules": [ # Set of detection rules to apply to all findings of this CustomInfoType. Rules are applied in the order that they are specified. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - { # Deprecated; use `InspectionRuleSet` instead. Rule for modifying a `CustomInfoType` to alter behavior under certain circumstances, depending on the specific details of the rule. Not supported for the `surrogate_type` custom infoType. - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # A list of phrases to detect as a CustomInfoType. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "exclusionType": "A String", # If set to EXCLUSION_TYPE_EXCLUDE this infoType will not cause a finding to be returned. It still can be used for rules matching. Only supported for the `dictionary`, `regex`, and `stored_type` CustomInfoTypes. - "fileLabelInfoType": { # Configuration for a custom infoType that detects file labels. # File label to detect. - "googleDriveLabel": { # Google Drive labels published by Google. # Google Drive labels published by Google. - "labelFieldsToMatch": [ # The field values of the Google Drive label to match. - { # The field values of the Google Drive label to match. - "id": "A String", # The identifier of the Label Field. - "value": "A String", # The value of the Label Field to match. - }, - ], - "labelId": "A String", # The [label ID](https://developers.google.com/workspace/drive/labels/guides/overview) of the Google Drive label. - }, - "sensitivityLabel": { # Sensitivity labels published by Microsoft. # Sensitivity labels published by Microsoft. - "guid": "A String", # The GUID of the sensitivity label. - }, - }, - "infoType": { # Type of information detected by the API. # CustomInfoType can either be a new infoType, or an extension of built-in infoType, when the name matches one of existing infoTypes and that infoType is specified in `InspectContent.info_types` field. Specifying the latter adds findings to the one detected by the system. If built-in info type is not specified in `InspectContent.info_types` list then the name is treated as a custom info type. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "likelihood": "A String", # Likelihood to return for this CustomInfoType. This base value can be altered by a detection rule if the finding meets the criteria specified by the rule. Defaults to `VERY_LIKELY` if not specified. - "metadataKeyValueExpression": { # Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions. # Key-value pair to detect in the metadata. - "keyRegex": "A String", # The regular expression for the key. Key should be non-empty. - "valueRegex": "A String", # The regular expression for the value. Value should be non-empty. - }, - "regex": { # Message defining a custom regular expression. # Regular expression based CustomInfoType. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "storedType": { # A reference to a StoredInfoType to use with scanning. # Loads an existing `StoredInfoType` resource. - "createTime": "A String", # Timestamp indicating when the version of the `StoredInfoType` used for inspection was created. Output-only field, populated by the system. - "name": "A String", # Resource name of the requested `StoredInfoType`, for example `organizations/433245324/storedInfoTypes/432452342` or `projects/project-id/storedInfoTypes/432452342`. - }, - "surrogateType": { # Message for detecting output from deidentification transformations such as [`CryptoReplaceFfxFpeConfig`](https://docs.cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/organizations.deidentifyTemplates#cryptoreplaceffxfpeconfig). These types of transformations are those that perform pseudonymization, thereby producing a "surrogate" as output. This should be used in conjunction with a field on the transformation such as `surrogate_info_type`. This CustomInfoType does not support the use of `detection_rules`. # Message for detecting output from deidentification transformations that support reversing. - }, - }, - ], - "excludeInfoTypes": True or False, # When true, excludes type information of the findings. This is not used for data profiling. - "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote. This is not used for data profiling. - "infoTypes": [ # Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "limits": { # Configuration to control the number of findings returned for inspection. This is not used for de-identification or data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. # Configuration to control the number of findings returned. This is not used for data profiling. When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error. When set within an InspectJobConfig, the specified maximum values aren't hard limits. If an inspection job reaches these limits, the job ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than these maximum values. - "maxFindingsPerInfoType": [ # Configuration of findings limit given for specified infoTypes. - { # Max findings configuration per infoType, per content item or long running DlpJob. - "infoType": { # Type of information detected by the API. # Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "maxFindings": 42, # Max findings limit for the given infoType. - }, - ], - "maxFindingsPerItem": 42, # Max number of findings that are returned for each item scanned. When set within an InspectContentRequest, this field is ignored. This value isn't a hard limit. If the number of findings for an item reaches this limit, the inspection of that item ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns for the item can be multiple times higher than this value. - "maxFindingsPerRequest": 42, # Max number of findings that are returned per request or job. If you set this field in an InspectContentRequest, the resulting maximum value is the value that you set or 3,000, whichever is lower. This value isn't a hard limit. If an inspection reaches this limit, the inspection ends gradually, not abruptly. Therefore, the actual number of findings that Cloud DLP returns can be multiple times higher than this value. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. The default is POSSIBLE. In general, the highest likelihood setting yields the fewest findings in results and the lowest chance of a false positive. For more information, see [Match likelihood](https://docs.cloud.google.com/sensitive-data-protection/docs/likelihood). - "minLikelihoodPerInfoType": [ # Minimum likelihood per infotype. For each infotype, a user can specify a minimum likelihood. The system only returns a finding if its likelihood is above this threshold. If this field is not set, the system uses the InspectConfig min_likelihood. - { # Configuration for setting a minimum likelihood per infotype. Used to customize the minimum likelihood level for specific infotypes in the request. For example, use this if you want to lower the precision for PERSON_NAME without lowering the precision for the other infotypes in the request. - "infoType": { # Type of information detected by the API. # Type of information the likelihood threshold applies to. Only one likelihood per info_type should be provided. If InfoTypeLikelihood does not have an info_type, the configuration fails. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - "minLikelihood": "A String", # Only returns findings equal to or above this threshold. This field is required or else the configuration fails. - }, - ], - "ruleSet": [ # Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type. Not supported for the `metadata_key_value_expression` CustomInfoType. - { # Rule set for modifying a set of infoTypes to alter behavior under certain circumstances, depending on the specific details of the rules within the set. - "infoTypes": [ # List of infoTypes this rule set is applied to. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "rules": [ # Set of rules to be applied to infoTypes. The rules are applied in order. - { # A single inspection rule to be applied to infoTypes, specified in `InspectionRuleSet`. - "adjustmentRule": { # Rule that specifies conditions when a certain infoType's finding details should be adjusted. # Adjustment rule. - "adjustByImageFindings": { # AdjustmentRule condition for image findings. This rule is silently ignored if the content being inspected is not an image. # AdjustmentRule condition for image findings. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the adjustment rule. Sensitive Data Protection adjusts the likelihood of an image finding if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, you can create a rule to adjust the likelihood of a `US_PASSPORT` finding if it is enclosed by a finding of `OBJECT_TYPE/PERSON/PASSPORT`. To configure this, set `US_PASSPORT` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_image_findings.info_types` that contains `OBJECT_TYPE/PERSON/PASSPORT` and `image_containment_type` set to `encloses`. In this case, the likelihood of the `US_PASSPORT` finding is adjusted, but the likelihood of the `OBJECT_TYPE/PERSON/PASSPORT` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_image_findings.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "adjustByMatchingInfoTypes": { # AdjustmentRule condition for matching infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # Sensitive Data Protection adjusts the likelihood of a finding if that finding also matches one of these infoTypes. For example, you can create a rule to adjust the likelihood of a `PHONE_NUMBER` finding if the string is found within a document that is classified as `DOCUMENT_TYPE/HR/RESUME`. To configure this, set `PHONE_NUMBER` in `InspectionRuleSet.info_types`. Add an `adjustment_rule` with an `adjust_by_matching_info_types.info_types` that contains `DOCUMENT_TYPE/HR/RESUME`. In this case, the likelihood of the `PHONE_NUMBER` finding is adjusted, but the likelihood of the `DOCUMENT_TYPE/HR/RESUME` finding is not. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - "matchingType": "A String", # How the adjustment rule is applied. Only `MATCHING_TYPE_PARTIAL_MATCH` is supported: - Partial match: adjusts the findings of infoTypes specified in the inspection rule when they have a nonempty intersection with a finding of an infoType specified in this adjustment rule. - "minLikelihood": "A String", # Required. Minimum likelihood of the `adjust_by_matching_info_types.info_types` finding. If the likelihood is lower than this value, Sensitive Data Protection doesn't adjust the likelihood of the `InspectionRuleSet.info_types` finding. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to the infoType. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - }, - "exclusionRule": { # The rule that specifies conditions when findings of infoTypes specified in `InspectionRuleSet` are removed from results. # Exclusion rule. - "dictionary": { # Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles. Dictionary words are case-insensitive and all characters other than letters and digits in the unicode [Basic Multilingual Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane) will be replaced with whitespace when scanning for matches, so the dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters surrounding any match must be of a different type than the adjacent characters within the word, so letters must be next to non-letters and digits next to non-digits. For example, the dictionary word "jen" will match the first three letters of the text "jen123" but will return no matches for "jennifer". Dictionary words containing a large number of characters that are not letters or digits may result in unexpected findings because such characters are treated as whitespace. The [limits](https://docs.cloud.google.com/sensitive-data-protection/limits) page contains details about the size limits of dictionaries. For dictionaries that do not fit within these constraints, consider using `LargeCustomDictionaryConfig` in the `StoredInfoType` API. # Dictionary which defines the rule. - "cloudStoragePath": { # Message representing a single file or path in Cloud Storage. # Newline-delimited file of words in Cloud Storage. Only a single file is accepted. - "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt` - }, - "wordList": { # Message defining a list of words or phrases to search for in the data. # List of words or phrases to search for. - "words": [ # Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required] - "A String", - ], - }, - }, - "excludeByHotword": { # The rule to exclude findings based on a hotword. For record inspection of tables, column names are considered hotwords. An example of this is to exclude a finding if it belongs to a BigQuery column that matches a specific pattern. # Drop if the hotword rule is contained in the proximate context. For tabular data, the context includes the column name. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The windowBefore property in proximity should be set to 1 if the hotword needs to be included in a column header. - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - "excludeByImageFindings": { # The rule to exclude image findings based on spatial relationships with other image findings. For example, exclude an image finding if it overlaps with another image finding. This rule is silently ignored if the content being inspected is not an image. # Exclude findings based on image containment rules. For example, exclude an image finding if it overlaps with another image finding. - "imageContainmentType": { # Specifies the relationship between bounding boxes for image findings. # Specifies the required spatial relationship between the bounding boxes of the target finding and the context infoType findings. - "encloses": { # Defines a condition where one bounding box encloses another. # The context finding's bounding box must fully contain the target finding's bounding box. - }, - "fullyInside": { # Defines a condition where one bounding box is fully inside another. # The context finding's bounding box must be fully inside the target finding's bounding box. - }, - "overlaps": { # Defines a condition for overlapping bounding boxes. # The context finding's bounding box and the target finding's bounding box must have a non-zero intersection. - }, - }, - "infoTypes": [ # A list of image-supported infoTypes—excluding [document infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#documents)—to be used as context for the exclusion rule. A finding is excluded if its bounding box has the specified spatial relationship (defined by `image_containment_type`) with a finding of an infoType in this list. For example, if `InspectionRuleSet.info_types` includes `OBJECT_TYPE/PERSON` and this `exclusion_rule` specifies `info_types` as `OBJECT_TYPE/PERSON/PASSPORT` with `image_containment_type` set to `encloses`, then `OBJECT_TYPE/PERSON` findings will be excluded if they are fully contained within the bounding box of an `OBJECT_TYPE/PERSON/PASSPORT` finding. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "excludeInfoTypes": { # List of excluded infoTypes. # Set of infoTypes for which findings would affect this rule. - "infoTypes": [ # InfoType list in ExclusionRule rule drops a finding when it overlaps or contained within with a finding of an infoType from this list. For example, for `InspectionRuleSet.info_types` containing "PHONE_NUMBER"` and `exclusion_rule` containing `exclude_info_types.info_types` with "EMAIL_ADDRESS" the phone number findings are dropped if they overlap with EMAIL_ADDRESS finding. That leads to "555-222-2222@example.org" to generate only a single finding, namely email address. - { # Type of information detected by the API. - "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. - "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling. - "score": "A String", # The sensitivity score applied to the resource. - }, - "version": "A String", # Optional version name for this InfoType. - }, - ], - }, - "matchingType": "A String", # How the rule is applied, see MatchingType documentation for details. - "regex": { # Message defining a custom regular expression. # Regular expression which defines the rule. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - }, - "hotwordRule": { # The rule that adjusts the likelihood of findings within a certain proximity of hotwords. # Hotword-based detection rule. - "hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword. - "groupIndexes": [ # The index of the submatch to extract as findings. When not specified, the entire match is returned. No more than 3 may be included. - 42, - ], - "pattern": "A String", # Pattern defining the regular expression. Its syntax (https://github.com/google/re2/wiki/Syntax) can be found under the google/re2 repository on GitHub. - }, - "likelihoodAdjustment": { # Message for specifying an adjustment to the likelihood of a finding as part of a detection rule. # Likelihood adjustment to apply to all matching findings. - "fixedLikelihood": "A String", # Set the likelihood of a finding to a fixed value. - "relativeLikelihood": 42, # Increase or decrease the likelihood by the specified number of levels. For example, if a finding would be `POSSIBLE` without the detection rule and `relative_likelihood` is 1, then it is upgraded to `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`. Likelihood may never drop below `VERY_UNLIKELY` or exceed `VERY_LIKELY`, so applying an adjustment of 1 followed by an adjustment of -1 when base likelihood is `VERY_LIKELY` will result in a final likelihood of `LIKELY`. - }, - "proximity": { # Message for specifying a window around a finding to apply a detection rule. # Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question. For tabular data, if you want to modify the likelihood of an entire column of findngs, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - "windowAfter": 42, # Number of characters after the finding to consider. - "windowBefore": 42, # Number of characters before the finding to consider. For tabular data, if you want to modify the likelihood of an entire column of findngs, set this to 1. For more information, see [Hotword example: Set the match likelihood of a table column] (https://docs.cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values). - }, - }, - }, - ], - }, - ], - }, - "name": "A String", # Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; - "updateTime": "A String", # Output only. The last update timestamp of an inspectTemplate. - }, "loggingConfigs": [ # Optional. Log the actions taken by the content policy to external systems. { # A single logging configuration. "logToBigQuery": { # Configuration for logging content policy actions to BigQuery. # Optional. Log the actions taken to a BigQuery table. @@ -3700,7 +2123,6 @@

Method Details

}, }, ], - "returnVerdict": "A String", # If set, the verdict will be returned to the user. Deprecated: Use `action` instead. }, ], "unsupportedFileType": { # A possible action to take when applying a content policy. # Optional. Action to take if the content is an unsupported file type. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 5875f42101..69f173b3c1 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -8571,7 +8571,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 2a6e7154d7..5f39f15921 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -5397,7 +5397,12 @@

Method Details

"conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order. "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response. { # Single message in a conversation. - "content": "A String", # The contents of this message. + "content": "A String", # Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set. + "messageParts": [ # Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set. + { # A part of a conversation message. + "text": "A String", # String content for text-based messages. + }, + ], "messageType": "A String", # The type of message. "participantId": "A String", # Optional. The identifier of the participant, for example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters. }, diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 93b704938e..98d338867f 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5274,7 +5274,7 @@ } } }, -"revision": "20260825", +"revision": "20260829", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6828,11 +6828,6 @@ "$ref": "GooglePrivacyDlpV2InspectConfig", "description": "Optional. InspectConfig to use to produce findings." }, -"inspectTemplate": { -"$ref": "GooglePrivacyDlpV2InspectTemplate", -"deprecated": true, -"description": "Optional. InspectTemplate to use to produce findings. Deprecated: use inspect_config instead." -}, "loggingConfigs": { "description": "Optional. Log the actions taken by the content policy to external systems.", "items": { @@ -6900,9 +6895,17 @@ "id": "GooglePrivacyDlpV2ConversationMessage", "properties": { "content": { -"description": "The contents of this message.", +"deprecated": true, +"description": "Deprecated: Use `message_parts` instead. The contents of this message. Only one of `content` and `message_parts` can be set.", "type": "string" }, +"messageParts": { +"description": "Optional. The parts of the message. Restricted to being at most a single text item. Only one of `content` and `message_parts` can be set.", +"items": { +"$ref": "GooglePrivacyDlpV2MessagePart" +}, +"type": "array" +}, "messageType": { "description": "The type of message.", "enum": [ @@ -11375,6 +11378,17 @@ "properties": {}, "type": "object" }, +"GooglePrivacyDlpV2MessagePart": { +"description": "A part of a conversation message.", +"id": "GooglePrivacyDlpV2MessagePart", +"properties": { +"text": { +"description": "String content for text-based messages.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2MetadataKeyValueExpression": { "description": "Configuration for a custom infoType that detects key-value pairs in the metadata matching the specified regular expressions.", "id": "GooglePrivacyDlpV2MetadataKeyValueExpression", @@ -11719,21 +11733,6 @@ "$ref": "GooglePrivacyDlpV2PolicyCondition" }, "type": "array" -}, -"returnVerdict": { -"deprecated": true, -"description": "If set, the verdict will be returned to the user. Deprecated: Use `action` instead.", -"enum": [ -"CONTENT_POLICY_VERDICT_UNSPECIFIED", -"ALLOW", -"BLOCK" -], -"enumDescriptions": [ -"Not used.", -"The policy allows the provided content to be used.", -"The policy prevents the provided content from being used. This should result in a blocked file upload, exclusion from training dataset, or other similar block action. (specific action will depend on the caller)." -], -"type": "string" } }, "type": "object" From 98be5be82814d3c5ac955e30fec224715ca06a81 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:15 +0000 Subject: [PATCH 22/40] feat(drive): update the api #### drive:v3 The following keys were added: - resources.files.methods.copy.parameters.copyComments (Total Keys: 3) --- docs/dyn/drive_v3.files.html | 5 +++-- googleapiclient/discovery_cache/documents/drive.v3.json | 8 +++++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index b45af1bbe7..55ec0392bb 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

+ copy(fileId, body=None, copyComments=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)

Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).

create(body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, media_body=None, media_mime_type=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, useContentAsIndexableText=None, x__xgafv=None)

@@ -138,7 +138,7 @@

Method Details

- copy(fileId, body=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None) + copy(fileId, body=None, copyComments=None, enforceSingleParent=None, ignoreDefaultVisibility=None, includeLabels=None, includePermissionsForView=None, keepRevisionForever=None, ocrLanguage=None, supportsAllDrives=None, supportsTeamDrives=None, x__xgafv=None)
Creates a copy of a file and applies any requested updates with patch semantics. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
 
 Args:
@@ -455,6 +455,7 @@ 

Method Details

"writersCanShare": True or False, # Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives. } + copyComments: boolean, Whether to copy the comments associated with the file. enforceSingleParent: boolean, Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead. ignoreDefaultVisibility: boolean, Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index b321db15de..0434def287 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1344,6 +1344,12 @@ "fileId" ], "parameters": { +"copyComments": { +"default": "false", +"description": "Whether to copy the comments associated with the file.", +"location": "query", +"type": "boolean" +}, "enforceSingleParent": { "default": "false", "deprecated": true, @@ -3038,7 +3044,7 @@ } } }, -"revision": "20260823", +"revision": "20260901", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { From 7ca02b613d7a05b0fea9936bce29613ff11a8c62 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:15 +0000 Subject: [PATCH 23/40] feat(file): update the api #### file:v1beta1 The following keys were deleted: - schemas.InstanceTemplate (Total Keys: 13) - schemas.VolumePool.properties.instanceListPageSize (Total Keys: 2) - schemas.VolumePool.properties.instanceNamePrefix.type (Total Keys: 1) - schemas.VolumePool.properties.instanceTemplate.$ref (Total Keys: 1) - schemas.VolumePool.properties.maxAcquireCandidates (Total Keys: 2) - schemas.VolumePool.properties.maxInstances (Total Keys: 2) - schemas.VolumePool.properties.maxPendingInstanceCreations (Total Keys: 2) - schemas.VolumePool.properties.maxPendingVolumeCreationsPerInstance (Total Keys: 2) - schemas.VolumePool.properties.maxPendingVolumeDeletionsPerInstance (Total Keys: 2) - schemas.VolumePool.properties.maxVolumesPerInstance (Total Keys: 2) - schemas.VolumePool.properties.minAvailableVolumes (Total Keys: 2) - schemas.VolumePool.properties.minInstances (Total Keys: 2) - schemas.VolumePool.properties.negbaInstanceRatio (Total Keys: 2) - schemas.VolumePool.properties.operationPollLimit (Total Keys: 2) - schemas.VolumePool.properties.state (Total Keys: 2) - schemas.VolumePool.properties.uniqueId (Total Keys: 2) - schemas.VolumePool.properties.volumeBatchSize (Total Keys: 2) - schemas.VolumePool.properties.volumeSizeMb (Total Keys: 2) The following keys were added: - schemas.Backup.properties.sourceVolume.type (Total Keys: 1) - schemas.Share.properties.capacityMb (Total Keys: 2) - schemas.VolumePool.properties.activeVolumeIops (Total Keys: 2) - schemas.VolumePool.properties.defaultVolumeQuotaMib (Total Keys: 2) - schemas.VolumePool.properties.network.type (Total Keys: 1) - schemas.VolumePool.properties.uid (Total Keys: 2) --- ...le_v1beta1.projects.locations.backups.html | 4 + ...1.projects.locations.instances.shares.html | 12 +- ...1beta1.projects.locations.volumePools.html | 220 ++---------------- .../documents/file.v1beta1.json | 203 ++-------------- 4 files changed, 52 insertions(+), 387 deletions(-) diff --git a/docs/dyn/file_v1beta1.projects.locations.backups.html b/docs/dyn/file_v1beta1.projects.locations.backups.html index 47aa1650a5..426fe92581 100644 --- a/docs/dyn/file_v1beta1.projects.locations.backups.html +++ b/docs/dyn/file_v1beta1.projects.locations.backups.html @@ -126,6 +126,7 @@

Method Details

"sourceFileShare": "A String", # Name of the file share in the source Filestore instance that the backup is created from. "sourceInstance": "A String", # The resource name of the source Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. "sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. + "sourceVolume": "A String", # Optional. The resource name of the Filestore volume that the backup is created from. Should be in the format: projects/{project_id}/locations/{location_id}/volumePools/{volume_pool_id}/volumes/{volume_id} "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. "tags": { # Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value @@ -228,6 +229,7 @@

Method Details

"sourceFileShare": "A String", # Name of the file share in the source Filestore instance that the backup is created from. "sourceInstance": "A String", # The resource name of the source Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. "sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. + "sourceVolume": "A String", # Optional. The resource name of the Filestore volume that the backup is created from. Should be in the format: projects/{project_id}/locations/{location_id}/volumePools/{volume_pool_id}/volumes/{volume_id} "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. "tags": { # Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value @@ -272,6 +274,7 @@

Method Details

"sourceFileShare": "A String", # Name of the file share in the source Filestore instance that the backup is created from. "sourceInstance": "A String", # The resource name of the source Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. "sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. + "sourceVolume": "A String", # Optional. The resource name of the Filestore volume that the backup is created from. Should be in the format: projects/{project_id}/locations/{location_id}/volumePools/{volume_pool_id}/volumes/{volume_id} "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. "tags": { # Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value @@ -325,6 +328,7 @@

Method Details

"sourceFileShare": "A String", # Name of the file share in the source Filestore instance that the backup is created from. "sourceInstance": "A String", # The resource name of the source Filestore instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`, used to create this backup. "sourceInstanceTier": "A String", # Output only. The service tier of the source Filestore instance that this backup is created from. + "sourceVolume": "A String", # Optional. The resource name of the Filestore volume that the backup is created from. Should be in the format: projects/{project_id}/locations/{location_id}/volumePools/{volume_pool_id}/volumes/{volume_id} "state": "A String", # Output only. The backup state. "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. "tags": { # Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.shares.html b/docs/dyn/file_v1beta1.projects.locations.instances.shares.html index 04cfc163ea..321cb221b4 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.shares.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.shares.html @@ -112,7 +112,8 @@

Method Details

{ # A Filestore share. "backup": "A String", # Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup. - "capacityGb": "A String", # File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. + "capacityGb": "A String", # Optional. File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. + "capacityMb": "A String", # Optional. File share capacity in Megabytes (MB). Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. "createTime": "A String", # Output only. The time when the share was created. "description": "A String", # A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected. "labels": { # Resource labels to represent user provided metadata. @@ -219,7 +220,8 @@

Method Details

{ # A Filestore share. "backup": "A String", # Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup. - "capacityGb": "A String", # File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. + "capacityGb": "A String", # Optional. File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. + "capacityMb": "A String", # Optional. File share capacity in Megabytes (MB). Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. "createTime": "A String", # Output only. The time when the share was created. "description": "A String", # A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected. "labels": { # Resource labels to represent user provided metadata. @@ -269,7 +271,8 @@

Method Details

"shares": [ # A list of shares in the project for the specified instance. { # A Filestore share. "backup": "A String", # Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup. - "capacityGb": "A String", # File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. + "capacityGb": "A String", # Optional. File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. + "capacityMb": "A String", # Optional. File share capacity in Megabytes (MB). Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. "createTime": "A String", # Output only. The time when the share was created. "description": "A String", # A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected. "labels": { # Resource labels to represent user provided metadata. @@ -326,7 +329,8 @@

Method Details

{ # A Filestore share. "backup": "A String", # Immutable. Full name of the Cloud Filestore Backup resource that this Share is restored from, in the format of projects/{project_id}/locations/{location_id}/backups/{backup_id}. Empty, if the Share is created from scratch and not restored from a backup. - "capacityGb": "A String", # File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. + "capacityGb": "A String", # Optional. File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. + "capacityMb": "A String", # Optional. File share capacity in Megabytes (MB). Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified. "createTime": "A String", # Output only. The time when the share was created. "description": "A String", # A description of the share with 2048 characters or less. Requests with longer descriptions will be rejected. "labels": { # Resource labels to represent user provided metadata. diff --git a/docs/dyn/file_v1beta1.projects.locations.volumePools.html b/docs/dyn/file_v1beta1.projects.locations.volumePools.html index 978dcbc915..8f14f566e2 100644 --- a/docs/dyn/file_v1beta1.projects.locations.volumePools.html +++ b/docs/dyn/file_v1beta1.projects.locations.volumePools.html @@ -116,63 +116,16 @@

Method Details

The object takes the form of: { # VolumePool representation of a Cloud Filestore volume pool. + "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume. "createTime": "A String", # Output only. The time when the volume pool was created. + "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Default: 1024 MiB. "description": "A String", # Optional. A description of the volume pool with 2048 characters or less. - "instanceListPageSize": 42, # Optional. The page size to use when listing instances. - "instanceNamePrefix": "A String", # Optional. Instance name prefix. - "instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details. - "backendType": "A String", # Optional. Backend type. - "capacityGb": 42, # Optional. Capacity in GB. - "labels": { # Optional. Instance labels. - "a_key": "A String", - }, - "networks": [ # Optional. Network configurations. - { # Network configuration for the instance. - "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. - "ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`. - "A String", - ], - "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. - "A String", - ], - "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. - "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. - "endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. - "requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field. - }, - "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. - }, - ], - "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration. - "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIops": "A String", # Required. Maximum IOPS. - }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. - }, - }, - "protocol": "A String", # Optional. File protocol. - "requestOverrides": "A String", # Optional. Request overrides in JSON format. - "tier": "A String", # Optional. Tier of the instance. - }, "labels": { # Optional. Resource labels to represent user provided metadata. "a_key": "A String", }, - "maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume. - "maxInstances": 42, # Optional. Maximum number of instances to create. - "maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests. - "maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance. - "maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance. - "maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance. - "minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain. - "minInstances": 42, # Optional. Minimum number of instances to create. "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. - "negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1. - "operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run. - "state": "A String", # Output only. The volume pool state. - "uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE. - "volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch. - "volumeSizeMb": 42, # Optional. Volume size in MiB. + "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported. + "uid": "A String", # Output only. System-assigned unique identifier for the volume pool. } volumePoolId: string, Required. The ID to use for the volume pool, which will become the final component of the volume pool's resource name. @@ -255,63 +208,16 @@

Method Details

An object of the form: { # VolumePool representation of a Cloud Filestore volume pool. + "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume. "createTime": "A String", # Output only. The time when the volume pool was created. + "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Default: 1024 MiB. "description": "A String", # Optional. A description of the volume pool with 2048 characters or less. - "instanceListPageSize": 42, # Optional. The page size to use when listing instances. - "instanceNamePrefix": "A String", # Optional. Instance name prefix. - "instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details. - "backendType": "A String", # Optional. Backend type. - "capacityGb": 42, # Optional. Capacity in GB. - "labels": { # Optional. Instance labels. - "a_key": "A String", - }, - "networks": [ # Optional. Network configurations. - { # Network configuration for the instance. - "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. - "ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`. - "A String", - ], - "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. - "A String", - ], - "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. - "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. - "endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. - "requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field. - }, - "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. - }, - ], - "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration. - "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIops": "A String", # Required. Maximum IOPS. - }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. - }, - }, - "protocol": "A String", # Optional. File protocol. - "requestOverrides": "A String", # Optional. Request overrides in JSON format. - "tier": "A String", # Optional. Tier of the instance. - }, "labels": { # Optional. Resource labels to represent user provided metadata. "a_key": "A String", }, - "maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume. - "maxInstances": 42, # Optional. Maximum number of instances to create. - "maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests. - "maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance. - "maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance. - "maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance. - "minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain. - "minInstances": 42, # Optional. Minimum number of instances to create. "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. - "negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1. - "operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run. - "state": "A String", # Output only. The volume pool state. - "uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE. - "volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch. - "volumeSizeMb": 42, # Optional. Volume size in MiB. + "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported. + "uid": "A String", # Output only. System-assigned unique identifier for the volume pool. }
@@ -340,63 +246,16 @@

Method Details

], "volumePools": [ # Unordered list. A list of volume pools in the project for the specified location. { # VolumePool representation of a Cloud Filestore volume pool. + "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume. "createTime": "A String", # Output only. The time when the volume pool was created. + "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Default: 1024 MiB. "description": "A String", # Optional. A description of the volume pool with 2048 characters or less. - "instanceListPageSize": 42, # Optional. The page size to use when listing instances. - "instanceNamePrefix": "A String", # Optional. Instance name prefix. - "instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details. - "backendType": "A String", # Optional. Backend type. - "capacityGb": 42, # Optional. Capacity in GB. - "labels": { # Optional. Instance labels. - "a_key": "A String", - }, - "networks": [ # Optional. Network configurations. - { # Network configuration for the instance. - "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. - "ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`. - "A String", - ], - "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. - "A String", - ], - "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. - "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. - "endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. - "requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field. - }, - "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. - }, - ], - "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration. - "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIops": "A String", # Required. Maximum IOPS. - }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. - }, - }, - "protocol": "A String", # Optional. File protocol. - "requestOverrides": "A String", # Optional. Request overrides in JSON format. - "tier": "A String", # Optional. Tier of the instance. - }, "labels": { # Optional. Resource labels to represent user provided metadata. "a_key": "A String", }, - "maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume. - "maxInstances": 42, # Optional. Maximum number of instances to create. - "maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests. - "maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance. - "maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance. - "maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance. - "minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain. - "minInstances": 42, # Optional. Minimum number of instances to create. "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. - "negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1. - "operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run. - "state": "A String", # Output only. The volume pool state. - "uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE. - "volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch. - "volumeSizeMb": 42, # Optional. Volume size in MiB. + "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported. + "uid": "A String", # Output only. System-assigned unique identifier for the volume pool. }, ], } @@ -426,63 +285,16 @@

Method Details

The object takes the form of: { # VolumePool representation of a Cloud Filestore volume pool. + "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume. "createTime": "A String", # Output only. The time when the volume pool was created. + "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Default: 1024 MiB. "description": "A String", # Optional. A description of the volume pool with 2048 characters or less. - "instanceListPageSize": 42, # Optional. The page size to use when listing instances. - "instanceNamePrefix": "A String", # Optional. Instance name prefix. - "instanceTemplate": { # InstanceTemplate representation of a Cloud Filestore volume pool instance template. # Optional. Instance template details. - "backendType": "A String", # Optional. Backend type. - "capacityGb": 42, # Optional. Capacity in GB. - "labels": { # Optional. Instance labels. - "a_key": "A String", - }, - "networks": [ # Optional. Network configurations. - { # Network configuration for the instance. - "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. - "ipAddresses": [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`. - "A String", - ], - "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. - "A String", - ], - "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. - "pscConfig": { # Private Service Connect configuration. # Optional. Private Service Connect configuration. Should only be set when connect_mode is PRIVATE_SERVICE_CONNECT. - "endpointProject": "A String", # Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project. - "requestedIpAddress": "A String", # Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field. - }, - "reservedIpRange": "A String", # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier, a /24 CIDR block for High Scale tier, or a /26 CIDR block for Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29, 192.168.0.0/24, or 192.168.0.0/26, respectively. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Filestore instances in the selected VPC network. - }, - ], - "performanceConfig": { # Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). # Optional. Performance configuration. - "fixedIops": { # Fixed IOPS (input/output operations per second) parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIops": "A String", # Required. Maximum IOPS. - }, - "iopsPerTb": { # IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). # Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxIopsPerTb": "A String", # Required. Maximum IOPS per TiB. - }, - }, - "protocol": "A String", # Optional. File protocol. - "requestOverrides": "A String", # Optional. Request overrides in JSON format. - "tier": "A String", # Optional. Tier of the instance. - }, "labels": { # Optional. Resource labels to represent user provided metadata. "a_key": "A String", }, - "maxAcquireCandidates": 42, # Optional. The maximum number of candidates to fetch when acquiring a volume. - "maxInstances": 42, # Optional. Maximum number of instances to create. - "maxPendingInstanceCreations": 42, # Optional. The maximum number of pending instance creation requests. - "maxPendingVolumeCreationsPerInstance": 42, # Optional. The maximum number of pending volume creation requests per instance. - "maxPendingVolumeDeletionsPerInstance": 42, # Optional. The maximum number of pending volume deletion requests per instance. - "maxVolumesPerInstance": 42, # Optional. Maximum number of volumes per instance. - "minAvailableVolumes": 42, # Optional. Minimum number of available volumes to maintain. - "minInstances": 42, # Optional. Minimum number of instances to create. "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. - "negbaInstanceRatio": 3.14, # Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1. - "operationPollLimit": 42, # Optional. The maximum number of operations to poll in a single reconciliation run. - "state": "A String", # Output only. The volume pool state. - "uniqueId": "A String", # Output only. Unique ID of the resource, as defined by CCFE. - "volumeBatchSize": 42, # Optional. The number of volumes to create in a single batch. - "volumeSizeMb": 42, # Optional. Volume size in MiB. + "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported. + "uid": "A String", # Output only. System-assigned unique identifier for the volume pool. } updateMask: string, Optional. Mask of fields to update. At least one path must be supplied in this field. diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index 967d74eca2..a333a69e57 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -1735,7 +1735,7 @@ } } }, -"revision": "20260819", +"revision": "20260827", "rootUrl": "https://file.googleapis.com/", "schemas": { "AcquireShareRequest": { @@ -1871,6 +1871,10 @@ "readOnly": true, "type": "string" }, +"sourceVolume": { +"description": "Optional. The resource name of the Filestore volume that the backup is created from. Should be in the format: projects/{project_id}/locations/{location_id}/volumePools/{volume_pool_id}/volumes/{volume_id}", +"type": "string" +}, "state": { "description": "Output only. The backup state.", "enum": [ @@ -2568,94 +2572,6 @@ }, "type": "object" }, -"InstanceTemplate": { -"description": "InstanceTemplate representation of a Cloud Filestore volume pool instance template.", -"id": "InstanceTemplate", -"properties": { -"backendType": { -"description": "Optional. Backend type.", -"enum": [ -"BACKEND_TYPE_UNSPECIFIED", -"COMPUTE_BASED_BACKEND", -"FILESTORE_BACKEND" -], -"enumDescriptions": [ -"Backend type not set.", -"Instance is backed by Compute.", -"Instance is backed by Filestore." -], -"type": "string" -}, -"capacityGb": { -"description": "Optional. Capacity in GB.", -"format": "int32", -"type": "integer" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Instance labels.", -"type": "object" -}, -"networks": { -"description": "Optional. Network configurations.", -"items": { -"$ref": "NetworkConfig" -}, -"type": "array" -}, -"performanceConfig": { -"$ref": "PerformanceConfig", -"description": "Optional. Performance configuration." -}, -"protocol": { -"description": "Optional. File protocol.", -"enum": [ -"FILE_PROTOCOL_UNSPECIFIED", -"NFS_V3", -"NFS_V4_1" -], -"enumDescriptions": [ -"FILE_PROTOCOL_UNSPECIFIED serves a \"not set\" default value when a FileProtocol is a separate field in a message.", -"NFS 3.0.", -"NFS 4.1." -], -"type": "string" -}, -"requestOverrides": { -"description": "Optional. Request overrides in JSON format.", -"type": "string" -}, -"tier": { -"description": "Optional. Tier of the instance.", -"enum": [ -"TIER_UNSPECIFIED", -"STANDARD", -"PREMIUM", -"BASIC_HDD", -"BASIC_SSD", -"HIGH_SCALE_SSD", -"ENTERPRISE", -"ZONAL", -"REGIONAL" -], -"enumDescriptions": [ -"Not set.", -"STANDARD tier. BASIC_HDD is the preferred term for this tier.", -"PREMIUM tier. BASIC_SSD is the preferred term for this tier.", -"BASIC instances offer a maximum capacity of 63.9 TB. BASIC_HDD is an alias for STANDARD Tier, offering economical performance backed by HDD.", -"BASIC instances offer a maximum capacity of 63.9 TB. BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance backed by SSD.", -"HIGH_SCALE instances offer expanded capacity and performance scaling capabilities.", -"ENTERPRISE instances offer the features and availability needed for mission-critical workloads.", -"ZONAL instances offer expanded capacity and performance scaling capabilities.", -"REGIONAL instances offer the features and availability needed for mission-critical workloads." -], -"type": "string" -} -}, -"type": "object" -}, "LdapConfig": { "description": "LdapConfig contains all the parameters for connecting to LDAP servers.", "id": "LdapConfig", @@ -3524,7 +3440,12 @@ "type": "string" }, "capacityGb": { -"description": "File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0.", +"description": "Optional. File share capacity in gigabytes (GB). Filestore defines 1 GB as 1024^3 bytes. Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified.", +"format": "int64", +"type": "string" +}, +"capacityMb": { +"description": "Optional. File share capacity in Megabytes (MB). Must be greater than 0. Exactly one of capacity_gb or capacity_mb must be specified.", "format": "int64", "type": "string" }, @@ -3769,29 +3690,26 @@ "description": "VolumePool representation of a Cloud Filestore volume pool.", "id": "VolumePool", "properties": { +"activeVolumeIops": { +"description": "Optional. The number of IOPs provisioned per active volume.", +"format": "int32", +"type": "integer" +}, "createTime": { "description": "Output only. The time when the volume pool was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"description": { -"description": "Optional. A description of the volume pool with 2048 characters or less.", -"type": "string" -}, -"instanceListPageSize": { -"description": "Optional. The page size to use when listing instances.", +"defaultVolumeQuotaMib": { +"description": "Optional. The default quota per volume in MiB. Default: 1024 MiB.", "format": "int32", "type": "integer" }, -"instanceNamePrefix": { -"description": "Optional. Instance name prefix.", +"description": { +"description": "Optional. A description of the volume pool with 2048 characters or less.", "type": "string" }, -"instanceTemplate": { -"$ref": "InstanceTemplate", -"description": "Optional. Instance template details." -}, "labels": { "additionalProperties": { "type": "string" @@ -3799,91 +3717,18 @@ "description": "Optional. Resource labels to represent user provided metadata.", "type": "object" }, -"maxAcquireCandidates": { -"description": "Optional. The maximum number of candidates to fetch when acquiring a volume.", -"format": "int32", -"type": "integer" -}, -"maxInstances": { -"description": "Optional. Maximum number of instances to create.", -"format": "int32", -"type": "integer" -}, -"maxPendingInstanceCreations": { -"description": "Optional. The maximum number of pending instance creation requests.", -"format": "int32", -"type": "integer" -}, -"maxPendingVolumeCreationsPerInstance": { -"description": "Optional. The maximum number of pending volume creation requests per instance.", -"format": "int32", -"type": "integer" -}, -"maxPendingVolumeDeletionsPerInstance": { -"description": "Optional. The maximum number of pending volume deletion requests per instance.", -"format": "int32", -"type": "integer" -}, -"maxVolumesPerInstance": { -"description": "Optional. Maximum number of volumes per instance.", -"format": "int32", -"type": "integer" -}, -"minAvailableVolumes": { -"description": "Optional. Minimum number of available volumes to maintain.", -"format": "int32", -"type": "integer" -}, -"minInstances": { -"description": "Optional. Minimum number of instances to create.", -"format": "int32", -"type": "integer" -}, "name": { "description": "Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", "type": "string" }, -"negbaInstanceRatio": { -"description": "Optional. The ratio of Negba instances to maintain in the volume pool, between 0 and 1.", -"format": "float", -"type": "number" -}, -"operationPollLimit": { -"description": "Optional. The maximum number of operations to poll in a single reconciliation run.", -"format": "int32", -"type": "integer" -}, -"state": { -"description": "Output only. The volume pool state.", -"enum": [ -"STATE_UNSPECIFIED", -"READY", -"DELETING", -"INVALID" -], -"enumDescriptions": [ -"State not set.", -"Volume pool is ready for use.", -"Volume pool is being deleted.", -"Volume pool is in an invalid state." -], -"readOnly": true, +"network": { +"description": "Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported.", "type": "string" }, -"uniqueId": { -"description": "Output only. Unique ID of the resource, as defined by CCFE.", +"uid": { +"description": "Output only. System-assigned unique identifier for the volume pool.", "readOnly": true, "type": "string" -}, -"volumeBatchSize": { -"description": "Optional. The number of volumes to create in a single batch.", -"format": "int32", -"type": "integer" -}, -"volumeSizeMb": { -"description": "Optional. Volume size in MiB.", -"format": "int32", -"type": "integer" } }, "type": "object" From 2c4b4adc77f107f39e73ba160c99069ebdd29b8c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:16 +0000 Subject: [PATCH 24/40] feat(firebaseml): update the api #### firebaseml:v2beta The following keys were added: - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.translationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1TranslationConfig (Total Keys: 4) --- ....projects.locations.publishers.models.html | 12 ++++++++++ .../documents/firebaseml.v2beta.json | 23 +++++++++++++++++-- 2 files changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 67de49605c..ca3af32250 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -356,6 +356,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -977,6 +981,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -1914,6 +1922,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 5ee715e52a..aa2446d445 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20260823", +"revision": "20260830", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1625,6 +1625,10 @@ "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" +}, +"translationConfig": { +"$ref": "GoogleCloudAiplatformV1beta1TranslationConfig", +"description": "Optional. Config for translation." } }, "type": "object" @@ -2394,7 +2398,7 @@ "AGENTIC" ], "enumDescriptions": [ -"Default. Uses model-specific processing (3.5 Pro+ -> `AGENTIC`, older models -> `STATIC`).", +"Defaults to model-specific processing.", "Fixed-rate frame extraction. All frames placed in context.", "Model-driven dynamic navigation. Recommended for most use cases." ], @@ -3415,6 +3419,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1TranslationConfig": { +"description": "Config for translation features.", +"id": "GoogleCloudAiplatformV1beta1TranslationConfig", +"properties": { +"echoTargetLanguage": { +"description": "Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language.", +"type": "boolean" +}, +"targetLanguageCode": { +"description": "Required. The target language for translation. Supported values are BCP-47 language codes (e.g. \"en\", \"es\", \"fr\").", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1UrlContext": { "description": "Tool to support URL context.", "id": "GoogleCloudAiplatformV1beta1UrlContext", From e21c356c0d6909a5b8f89a5c3aaf4df03d7910cd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:16 +0000 Subject: [PATCH 25/40] feat(gkebackup): update the api #### gkebackup:v1 The following keys were added: - schemas.BDRBackupRestoreJobLog.properties.autoProtectionPolicy.type (Total Keys: 1) --- .../discovery_cache/documents/gkebackup.v1.json | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index 59597a4628..62fde37bba 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -2560,7 +2560,7 @@ } } }, -"revision": "20260715", +"revision": "20260826", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2697,9 +2697,13 @@ "type": "object" }, "BDRBackupRestoreJobLog": { -"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 26", +"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 27", "id": "BDRBackupRestoreJobLog", "properties": { +"autoProtectionPolicy": { +"description": "The auto-protection policy that created the backup.", +"type": "string" +}, "backupConsistencyTime": { "description": "Backup consistency time.", "format": "google-datetime", From 337dc90f735e6fc3e4b2dc816bc62b763cecfb4b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:16 +0000 Subject: [PATCH 26/40] fix(health): update the api #### health:v4 The following keys were changed: - resources.users.methods.getIdentity.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.dailyRollUp.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.get.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.list.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.reconcile.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.rollUp.scopes (Total Keys: 1) --- .../health_v4.users.dataTypes.dataPoints.html | 4 +-- .../discovery_cache/documents/health.v4.json | 33 +++++++++++++++++-- 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index fd0c488ae5..d95b30120b 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -1666,7 +1666,7 @@

Method Details

}, }, }, - "windowSizeDays": 42, # Optional. Aggregation window size, in number of days. Defaults to 1 if not specified. + "windowSizeDays": 42, # Optional. Aggregation window size, in number of days. Defaults to 1 if not specified. If the requested range is not an exact multiple of `window_size_days`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size_days`. } x__xgafv: string, V1 error format. @@ -7382,7 +7382,7 @@

Method Details

"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, - "windowSize": "A String", # Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second. + "windowSize": "A String", # Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second. If the requested range is not an exact multiple of `window_size`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size`. } x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index 43971f6752..dff829c9ac 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -26,9 +26,15 @@ "https://www.googleapis.com/auth/googlehealth.location.readonly": { "description": "See exercise GPS location data in Google Health" }, +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly": { +"description": "See your Google Health logged symptoms data" +}, "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly": { "description": "Add logged symptoms data to Google Health, and edit or delete the data it adds" }, +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly": { +"description": "See your Google Health mindfulness data" +}, "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly": { "description": "Add mindfulness data to Google Health, and edit or delete the data it adds" }, @@ -41,6 +47,9 @@ "https://www.googleapis.com/auth/googlehealth.profile.writeonly": { "description": "Add profile data to Google Health, and edit or delete the data it adds." }, +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly": { +"description": "See your Google Health reproductive health data" +}, "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly": { "description": "Add reproductive health data to Google Health, and edit or delete the data it adds" }, @@ -528,7 +537,10 @@ "https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.irn.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", "https://www.googleapis.com/auth/googlehealth.profile.readonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", "https://www.googleapis.com/auth/googlehealth.settings.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly" ] @@ -780,9 +792,12 @@ "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" @@ -848,9 +863,12 @@ "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" @@ -899,9 +917,12 @@ "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" @@ -989,9 +1010,12 @@ "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" @@ -1027,9 +1051,12 @@ "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", +"https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", +"https://www.googleapis.com/auth/googlehealth.mindfulness.readonly", "https://www.googleapis.com/auth/googlehealth.mindfulness.writeonly", "https://www.googleapis.com/auth/googlehealth.nutrition.writeonly", +"https://www.googleapis.com/auth/googlehealth.reproductive_health.readonly", "https://www.googleapis.com/auth/googlehealth.reproductive_health.writeonly", "https://www.googleapis.com/auth/googlehealth.sleep.readonly", "https://www.googleapis.com/auth/googlehealth.sleep.writeonly" @@ -1107,7 +1134,7 @@ } } }, -"revision": "20260825", +"revision": "20260904", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -1979,7 +2006,7 @@ "description": "Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days." }, "windowSizeDays": { -"description": "Optional. Aggregation window size, in number of days. Defaults to 1 if not specified.", +"description": "Optional. Aggregation window size, in number of days. Defaults to 1 if not specified. If the requested range is not an exact multiple of `window_size_days`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size_days`.", "format": "int32", "type": "integer" } @@ -5047,7 +5074,7 @@ "description": "Required. Closed-open range of data points that will be rolled up. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days." }, "windowSize": { -"description": "Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second.", +"description": "Required. The size of the time window to group data points into before applying the aggregation functions. Must be at least 1 second. If the requested range is not an exact multiple of `window_size`, the final bucket chronologically will be truncated at the upper endpoint of the range and will cover a duration shorter than `window_size`.", "format": "google-duration", "type": "string" } From 8bb38b7ee12c08ea88cf526e4e2bcadf9b720b8d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:16 +0000 Subject: [PATCH 27/40] feat(iam): update the api #### iam:v1 The following keys were added: - resources.locations.resources.workforcePools.resources.providers.resources.scimTenants.methods.getIamPolicy (Total Keys: 12) - resources.locations.resources.workforcePools.resources.providers.resources.scimTenants.methods.setIamPolicy (Total Keys: 12) - resources.locations.resources.workforcePools.resources.providers.resources.scimTenants.methods.testIamPermissions (Total Keys: 12) --- ....workforcePools.providers.scimTenants.html | 180 ++++++++++++++++++ .../discovery_cache/documents/iam.v1.json | 86 ++++++++- 2 files changed, 265 insertions(+), 1 deletion(-) diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html index 7a6ea3cdbd..1de90e20ad 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html @@ -91,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimTenant.

+

+ getIamPolicy(resource, body=None, x__xgafv=None)

+

Gets IAM policies on a WorkforcePool.

list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.

@@ -100,6 +103,12 @@

Instance Methods

patch(name, body=None, updateMask=None, x__xgafv=None)

Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimTenant.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets IAM policies on a WorkforcePool.

+

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

+

Returns the caller's permissions on the WorkforcePool. If the pool doesn't exist, this call returns an empty set of permissions. It doesn't return a `NOT_FOUND` error.

undelete(name, body=None, x__xgafv=None)

Gemini Enterprise only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.

@@ -211,6 +220,62 @@

Method Details

} +
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets IAM policies on a WorkforcePool.
+
+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)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.
@@ -306,6 +371,121 @@ 

Method Details

}
+
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets IAM policies on a WorkforcePool.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns the caller's permissions on the WorkforcePool. If the pool doesn't exist, this call returns an empty set of permissions. It doesn't return a `NOT_FOUND` error.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+
undelete(name, body=None, x__xgafv=None)
Gemini Enterprise only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.
diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json
index 8d5b152ff1..df0a962715 100644
--- a/googleapiclient/discovery_cache/documents/iam.v1.json
+++ b/googleapiclient/discovery_cache/documents/iam.v1.json
@@ -951,6 +951,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getIamPolicy": {
+"description": "Gets IAM policies on a WorkforcePool.",
+"flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "iam.locations.workforcePools.providers.scimTenants.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"request": {
+"$ref": "GetIamPolicyRequest"
+},
+"response": {
+"$ref": "Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.",
 "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants",
@@ -1026,6 +1054,62 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"setIamPolicy": {
+"description": "Sets IAM policies on a WorkforcePool.",
+"flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "iam.locations.workforcePools.providers.scimTenants.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "SetIamPolicyRequest"
+},
+"response": {
+"$ref": "Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Returns the caller's permissions on the WorkforcePool. If the pool doesn't exist, this call returns an empty set of permissions. It doesn't return a `NOT_FOUND` error.",
+"flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "iam.locations.workforcePools.providers.scimTenants.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:testIamPermissions",
+"request": {
+"$ref": "TestIamPermissionsRequest"
+},
+"response": {
+"$ref": "TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "undelete": {
 "description": "Gemini Enterprise only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.",
 "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:undelete",
@@ -4257,7 +4341,7 @@
 }
 }
 },
-"revision": "20260807",
+"revision": "20260828",
 "rootUrl": "https://iam.googleapis.com/",
 "schemas": {
 "AccessRestrictions": {

From a56873006d9ea96de1c0b522294e5fc6bd0dbcc9 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 8 Sep 2026 07:20:17 +0000
Subject: [PATCH 28/40] feat(looker): update the api

#### looker:v1

The following keys were added:
- endpoints (Total Keys: 1)
---
 .../discovery_cache/documents/looker.v1.json  | 54 ++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json
index c0e710a01a..322edd2e13 100644
--- a/googleapiclient/discovery_cache/documents/looker.v1.json
+++ b/googleapiclient/discovery_cache/documents/looker.v1.json
@@ -15,6 +15,58 @@
 "description": "",
 "discoveryVersion": "v1",
 "documentationLink": "https://cloud.google.com/looker/docs/reference/rest/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-central1.rep.googleapis.com/",
+"location": "us-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-east1.rep.googleapis.com/",
+"location": "us-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-east4.rep.googleapis.com/",
+"location": "us-east4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-east5.rep.googleapis.com/",
+"location": "us-east5"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-east7.rep.googleapis.com/",
+"location": "us-east7"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-south1.rep.googleapis.com/",
+"location": "us-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-west1.rep.googleapis.com/",
+"location": "us-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-west2.rep.googleapis.com/",
+"location": "us-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-west3.rep.googleapis.com/",
+"location": "us-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://looker.us-west4.rep.googleapis.com/",
+"location": "us-west4"
+}
+],
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -748,7 +800,7 @@
 }
 }
 },
-"revision": "20260806",
+"revision": "20260903",
 "rootUrl": "https://looker.googleapis.com/",
 "schemas": {
 "AdminSettings": {

From 1a77609167983dce9abd99ccace2cba8063d9c7b Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 8 Sep 2026 07:20:17 +0000
Subject: [PATCH 29/40] feat(merchantapi): update the api

#### merchantapi:products_v1

The following keys were added:
- schemas.ProductCertification.properties.certificationDocumentLink.type (Total Keys: 1)
- schemas.ProductCertification.properties.certificationLabelLink.type (Total Keys: 1)

#### merchantapi:products_v1beta

The following keys were added:
- schemas.Certification.properties.certificationDocumentLink.type (Total Keys: 1)
- schemas.Certification.properties.certificationLabelLink.type (Total Keys: 1)
---
 ...pi_products_v1.accounts.productInputs.html | 16 +++++--
 ...hantapi_products_v1.accounts.products.html |  8 +++-
 ...roducts_v1beta.accounts.productInputs.html | 16 +++++--
 ...api_products_v1beta.accounts.products.html |  8 +++-
 .../documents/merchantapi.accounts_v1.json    | 22 ++++++---
 .../merchantapi.accounts_v1beta.json          | 22 ++++++---
 .../documents/merchantapi.conversions_v1.json |  9 ++--
 .../merchantapi.conversions_v1beta.json       |  9 ++--
 .../documents/merchantapi.datasources_v1.json | 15 ++++---
 .../merchantapi.datasources_v1beta.json       | 15 ++++---
 .../documents/merchantapi.inventories_v1.json |  9 ++--
 .../merchantapi.inventories_v1beta.json       |  9 ++--
 .../merchantapi.issueresolution_v1.json       | 16 ++++---
 .../merchantapi.issueresolution_v1beta.json   | 16 ++++---
 .../documents/merchantapi.lfp_v1.json         |  9 ++--
 .../documents/merchantapi.lfp_v1beta.json     |  9 ++--
 .../merchantapi.loyaltycustomers_v1.json      |  9 ++--
 .../merchantapi.notifications_v1.json         |  9 ++--
 .../merchantapi.notifications_v1beta.json     |  9 ++--
 .../merchantapi.ordertracking_v1.json         |  9 ++--
 .../merchantapi.ordertracking_v1beta.json     |  9 ++--
 .../documents/merchantapi.products_v1.json    | 45 ++++++++++++++-----
 .../merchantapi.products_v1beta.json          | 33 ++++++++++----
 .../documents/merchantapi.promotions_v1.json  | 29 ++++++++----
 .../merchantapi.promotions_v1beta.json        | 29 ++++++++----
 .../documents/merchantapi.quota_v1.json       |  9 ++--
 .../documents/merchantapi.quota_v1beta.json   |  9 ++--
 .../documents/merchantapi.reports_v1.json     | 30 +++++++++----
 .../documents/merchantapi.reports_v1beta.json | 30 +++++++++----
 .../documents/merchantapi.reviews_v1beta.json | 37 ++++++++++-----
 30 files changed, 352 insertions(+), 152 deletions(-)

diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
index b007567d06..cf2fac74a7 100644
--- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
+++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
@@ -184,10 +184,12 @@ 

Method Details

"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information. }, ], - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -722,10 +724,12 @@

Method Details

"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information. }, ], - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -1261,10 +1265,12 @@

Method Details

"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information. }, ], - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -1800,10 +1806,12 @@

Method Details

"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information. }, ], - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 73ca7891d6..9d23b00fc6 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -184,10 +184,12 @@

Method Details

"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information. }, ], - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -781,10 +783,12 @@

Method Details

"region": "A String", # The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information. }, ], - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index ebad4bcea1..432c5b6a66 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -140,10 +140,12 @@

Method Details

"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. "brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google". "canonicalLink": "A String", # URL for the canonical version of your item's landing page. - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -465,10 +467,12 @@

Method Details

"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. "brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google". "canonicalLink": "A String", # URL for the canonical version of your item's landing page. - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -791,10 +795,12 @@

Method Details

"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. "brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google". "canonicalLink": "A String", # URL for the canonical version of your item's landing page. - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -1117,10 +1123,12 @@

Method Details

"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. "brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google". "canonicalLink": "A String", # URL for the canonical version of your item's landing page. - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index 7d03951bdc..d8d81ceb06 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -127,10 +127,12 @@

Method Details

"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. "brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google". "canonicalLink": "A String", # URL for the canonical version of your item's landing page. - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, @@ -511,10 +513,12 @@

Method Details

"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. "brand": "A String", # [Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, "Google". "canonicalLink": "A String", # URL for the canonical version of your item's landing page. - "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information. + "certifications": [ # Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). { # Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database. "certificationAuthority": "A String", # The certification authority, for example "European_Commission". Maximum length is 2000 characters. "certificationCode": "A String", # The certification code. Maximum length is 2000 characters. + "certificationDocumentLink": "A String", # Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). + "certificationLabelLink": "A String", # Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839). "certificationName": "A String", # The name of the certification, for example "EPREL". Maximum length is 2000 characters. "certificationValue": "A String", # The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 422713f834..002b55072f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -2438,7 +2438,7 @@ } } }, -"revision": "20260807", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -3166,7 +3166,8 @@ "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -3181,7 +3182,8 @@ "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -3810,7 +3812,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -3832,6 +3835,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3854,7 +3858,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -4785,7 +4790,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -4807,6 +4813,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4829,7 +4836,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 671f3b92e7..995ef2c055 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2388,7 +2388,7 @@ } } }, -"revision": "20260807", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -3046,7 +3046,8 @@ "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -3061,7 +3062,8 @@ "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -3687,7 +3689,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -3709,6 +3712,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3731,7 +3735,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -4662,7 +4667,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -4684,6 +4690,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4706,7 +4713,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json index 4ee3a01881..567dd7bb9a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json @@ -295,7 +295,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -524,7 +524,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -546,6 +547,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -568,7 +570,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json index d094e36bb2..ba897877fa 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json @@ -295,7 +295,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -524,7 +524,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -546,6 +547,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -568,7 +570,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json index d4964e4c88..81f41758de 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260719", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -449,7 +449,8 @@ "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -464,7 +465,8 @@ "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -833,7 +835,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -855,6 +858,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -877,7 +881,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 2203e40a02..ee1e1c4f3d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -321,7 +321,7 @@ } } }, -"revision": "20260719", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -449,7 +449,8 @@ "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -464,7 +465,8 @@ "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -845,7 +847,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -867,6 +870,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -889,7 +893,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 0c07edd03f..974eef8566 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json @@ -300,7 +300,7 @@ } } }, -"revision": "20260713", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -615,7 +615,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -637,6 +638,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -659,7 +661,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json index 520ba617ba..ca4c252449 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -506,7 +506,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -528,6 +529,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -550,7 +552,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json index 751e68e5c8..3160b1b427 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json @@ -268,7 +268,7 @@ } } }, -"revision": "20260713", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -420,7 +420,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -442,6 +443,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -464,7 +466,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -882,7 +885,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -904,6 +908,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -926,7 +931,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json index 15432703fa..23126d73d3 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json @@ -268,7 +268,7 @@ } } }, -"revision": "20260713", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -420,7 +420,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -442,6 +443,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -464,7 +466,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -882,7 +885,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -904,6 +908,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -926,7 +931,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json index a43e1b2d0b..cd26b9a10a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json @@ -327,7 +327,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CountrySettings": { @@ -782,7 +782,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -804,6 +805,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -826,7 +828,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json index f9424b21a8..2687e69f8b 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json @@ -327,7 +327,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CountrySettings": { @@ -782,7 +782,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -804,6 +805,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -826,7 +828,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json index 23b7bb6ec2..046d999ef2 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260805", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AddressInfo": { @@ -278,7 +278,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -300,6 +301,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -322,7 +324,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json index 928b8cdca0..4330a7f63b 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json @@ -262,7 +262,7 @@ } } }, -"revision": "20260817", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -365,7 +365,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -387,6 +388,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -409,7 +411,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json index cb77dccb8b..b3d11758ce 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json @@ -262,7 +262,7 @@ } } }, -"revision": "20260817", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -365,7 +365,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -387,6 +388,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -409,7 +411,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json index d9fea6aee6..8c41900420 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json @@ -147,7 +147,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DateTime": { @@ -353,7 +353,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -375,6 +376,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -397,7 +399,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json index af7ad1dd9a..1d37c99964 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1beta.json @@ -147,7 +147,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DateTime": { @@ -358,7 +358,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -380,6 +381,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -402,7 +404,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index 6545e131b5..e783b230ac 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260729", +"revision": "20260903", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -724,7 +724,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -746,6 +747,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -768,7 +770,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -966,7 +969,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -988,6 +992,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1010,7 +1015,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -1560,7 +1566,7 @@ false "type": "array" }, "certifications": { -"description": "Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information.", +"description": "Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839).", "items": { "$ref": "ProductCertification" }, @@ -1789,7 +1795,8 @@ false "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -1804,7 +1811,8 @@ false "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -1892,7 +1900,8 @@ false "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -1907,7 +1916,8 @@ false "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -2595,6 +2605,14 @@ false "description": "The certification code. Maximum length is 2000 characters.", "type": "string" }, +"certificationDocumentLink": { +"description": "Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839).", +"type": "string" +}, +"certificationLabelLink": { +"description": "Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839).", +"type": "string" +}, "certificationName": { "description": "The name of the certification.", "enum": [ @@ -2662,7 +2680,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -2684,6 +2703,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2706,7 +2726,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index e0412c49d8..9cf86379ee 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260527", +"revision": "20260903", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -340,7 +340,7 @@ "type": "string" }, "certifications": { -"description": "Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information.", +"description": "Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. For more information, see [Certification](https://support.google.com/merchants/answer/13528839).", "items": { "$ref": "Certification" }, @@ -776,6 +776,14 @@ "description": "The certification code. Maximum length is 2000 characters.", "type": "string" }, +"certificationDocumentLink": { +"description": "Optional. URL to the certification document (eg. `https://www.example.com/document`), for example, the product data sheet or fiche required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839).", +"type": "string" +}, +"certificationLabelLink": { +"description": "Optional. URL to the certification label (eg. `https://www.example.com/label`), for example, the energy efficiency label required by UK's DESNZ or EU's EPREL. Maximum length is 2000 characters. For more information, see [Certification](https://support.google.com/merchants/answer/13528839).", +"type": "string" +}, "certificationName": { "description": "The name of the certification, for example \"EPREL\". Maximum length is 2000 characters.", "type": "string" @@ -908,7 +916,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -930,6 +939,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -952,7 +962,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -1074,7 +1085,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1096,6 +1108,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1118,7 +1131,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -1359,7 +1373,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1381,6 +1396,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1403,7 +1419,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json index 9d5b475b16..a0dc9c9b90 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json @@ -203,7 +203,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -460,7 +460,8 @@ "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -475,7 +476,8 @@ "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -599,7 +601,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -621,6 +624,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -643,7 +647,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -765,7 +770,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -787,6 +793,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -809,7 +816,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -911,7 +919,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -933,6 +942,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -955,7 +965,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json index 6a993f4d97..b89d682f60 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -460,7 +460,8 @@ "FREE_VEHICLE_LISTINGS", "VEHICLE_ADS", "CLOUD_RETAIL", -"LOCAL_CLOUD_RETAIL" +"LOCAL_CLOUD_RETAIL", +"RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", @@ -475,7 +476,8 @@ "[Free vehicle listings](https://support.google.com/merchants/answer/11189169).", "[Vehicle ads](https://support.google.com/merchants/answer/11189169).", "[Cloud retail](https://cloud.google.com/solutions/retail).", -"[Local cloud retail](https://cloud.google.com/solutions/retail)." +"[Local cloud retail](https://cloud.google.com/solutions/retail).", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -599,7 +601,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -621,6 +624,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -643,7 +647,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -765,7 +770,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -787,6 +793,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -809,7 +816,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -911,7 +919,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -933,6 +942,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -955,7 +965,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json index 48a50b5d31..f41355f314 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json @@ -220,7 +220,7 @@ } } }, -"revision": "20260713", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AccountLimit": { @@ -339,7 +339,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -361,6 +362,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -383,7 +385,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json index 9046cacced..c1360320eb 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json @@ -150,7 +150,7 @@ } } }, -"revision": "20260713", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -236,7 +236,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -258,6 +259,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -280,7 +282,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json index f69333f349..768d0f5b56 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260715", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -657,7 +657,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -679,6 +680,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -701,7 +703,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -1043,7 +1046,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1065,6 +1069,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1087,7 +1092,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -1486,7 +1492,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1508,6 +1515,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1530,7 +1538,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -1688,7 +1697,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1710,6 +1720,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1732,7 +1743,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index 849b934d09..c7d3c1d58a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260715", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -657,7 +657,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -679,6 +680,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -701,7 +703,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -1043,7 +1046,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1065,6 +1069,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1087,7 +1092,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -1486,7 +1492,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1508,6 +1515,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1530,7 +1538,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" }, @@ -1688,7 +1697,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1710,6 +1720,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1732,7 +1743,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json index 6c3d4f04a6..cfce5e38d7 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json @@ -356,7 +356,7 @@ } } }, -"revision": "20260527", +"revision": "20260901", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -572,7 +572,8 @@ "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -594,6 +595,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -616,7 +618,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -675,7 +678,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -697,6 +701,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -719,7 +724,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -820,7 +826,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -842,6 +849,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -864,7 +872,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "type": "string" } @@ -1108,7 +1117,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1130,6 +1140,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1152,7 +1163,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" @@ -1211,7 +1223,8 @@ false "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", -"YOUTUBE_CHECKOUT" +"YOUTUBE_CHECKOUT", +"RENTAL_ADS" ], "enumDeprecated": [ false, @@ -1233,6 +1246,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1255,7 +1269,8 @@ false "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", -"YouTube Checkout ." +"YouTube Checkout .", +"Real Estate Rental Ads. ." ], "readOnly": true, "type": "string" From 31d315b67294d7f838bc8b5bb8a04eb295c1c3fc Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:17 +0000 Subject: [PATCH 30/40] feat(ondemandscanning): update the api #### ondemandscanning:v1 The following keys were added: - schemas.MaliciousContentLLMResult.properties.tokenUsage.$ref (Total Keys: 1) - schemas.TokenUsage (Total Keys: 12) #### ondemandscanning:v1beta1 The following keys were added: - schemas.MaliciousContentLLMResult.properties.tokenUsage.$ref (Total Keys: 1) - schemas.TokenUsage (Total Keys: 12) --- ...jects.locations.scans.vulnerabilities.html | 7 ++++ ...jects.locations.scans.vulnerabilities.html | 7 ++++ .../documents/ondemandscanning.v1.json | 38 ++++++++++++++++++- .../documents/ondemandscanning.v1beta1.json | 38 ++++++++++++++++++- 4 files changed, 88 insertions(+), 2 deletions(-) diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index 4f92c44544..6c4c9f5f26 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.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/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index e88cca1242..cda68993c3 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.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/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index b601c3e6ab..22225c4f80 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -344,7 +344,7 @@ } } }, -"revision": "20260821", +"revision": "20260828", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -2172,6 +2172,10 @@ "Scan was not performed." ], "type": "string" +}, +"tokenUsage": { +"$ref": "TokenUsage", +"description": "Telemetry metrics tracking token usage for the AI scan." } }, "type": "object" @@ -3465,6 +3469,38 @@ }, "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/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 30dbca0526..6854235430 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -344,7 +344,7 @@ } } }, -"revision": "20260821", +"revision": "20260828", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -2167,6 +2167,10 @@ "Scan was not performed." ], "type": "string" +}, +"tokenUsage": { +"$ref": "TokenUsage", +"description": "Telemetry metrics tracking token usage for the AI scan." } }, "type": "object" @@ -3460,6 +3464,38 @@ }, "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", From 7bd9f48b91c247376f3229cff9defa4f46e87875 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:17 +0000 Subject: [PATCH 31/40] feat(parametermanager): update the api #### parametermanager:v1 The following keys were added: - schemas.Parameter.properties.tags (Total Keys: 2) - schemas.ParameterVersion.properties.checksumSource (Total Keys: 2) - schemas.ParameterVersionPayload.properties.dataCrc32c (Total Keys: 2) The following keys were changed: - endpoints (Total Keys: 1) --- ...ager_v1.projects.locations.parameters.html | 18 +++++++++ ...rojects.locations.parameters.versions.html | 13 +++++++ .../documents/parametermanager.v1.json | 39 ++++++++++++++++++- 3 files changed, 69 insertions(+), 1 deletion(-) diff --git a/docs/dyn/parametermanager_v1.projects.locations.parameters.html b/docs/dyn/parametermanager_v1.projects.locations.parameters.html index b51ab4ef2b..3b94cf160b 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.parameters.html +++ b/docs/dyn/parametermanager_v1.projects.locations.parameters.html @@ -127,6 +127,9 @@

Method Details

"iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. + "a_key": "A String", + }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -152,6 +155,9 @@

Method Details

"iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. + "a_key": "A String", + }, "updateTime": "A String", # Output only. [Output only] Update time stamp }
@@ -201,6 +207,9 @@

Method Details

"iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. + "a_key": "A String", + }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -238,6 +247,9 @@

Method Details

"iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. + "a_key": "A String", + }, "updateTime": "A String", # Output only. [Output only] Update time stamp }, ], @@ -282,6 +294,9 @@

Method Details

"iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. + "a_key": "A String", + }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -307,6 +322,9 @@

Method Details

"iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, + "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. + "a_key": "A String", + }, "updateTime": "A String", # Output only. [Output only] Update time stamp } diff --git a/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html b/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html index fe74193770..7113173479 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html +++ b/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html @@ -114,12 +114,14 @@

Method Details

The object takes the form of: { # Message describing ParameterVersion resource + "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum. "createTime": "A String", # Output only. [Output only] Create time stamp "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False. "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured. "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request). "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -135,12 +137,14 @@

Method Details

An object of the form: { # Message describing ParameterVersion resource + "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum. "createTime": "A String", # Output only. [Output only] Create time stamp "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False. "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured. "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request). "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -185,12 +189,14 @@

Method Details

An object of the form: { # Message describing ParameterVersion resource + "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum. "createTime": "A String", # Output only. [Output only] Create time stamp "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False. "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured. "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request). "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -218,12 +224,14 @@

Method Details

"nextPageToken": "A String", # A token identifying a page of results the server should return. "parameterVersions": [ # The list of ParameterVersions { # Message describing ParameterVersion resource + "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum. "createTime": "A String", # Output only. [Output only] Create time stamp "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False. "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured. "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request). "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "updateTime": "A String", # Output only. [Output only] Update time stamp }, @@ -258,12 +266,14 @@

Method Details

The object takes the form of: { # Message describing ParameterVersion resource + "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum. "createTime": "A String", # Output only. [Output only] Create time stamp "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False. "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured. "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request). "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -279,12 +289,14 @@

Method Details

An object of the form: { # Message describing ParameterVersion resource + "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum. "createTime": "A String", # Output only. [Output only] Create time stamp "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False. "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured. "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request). "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "updateTime": "A String", # Output only. [Output only] Update time stamp } @@ -308,6 +320,7 @@

Method Details

"parameterVersion": "A String", # Output only. Resource identifier of a ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Payload content of a ParameterVersion resource. "data": "A String", # Required. bytes data for storing payload. + "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, "renderedPayload": "A String", # Output only. Server generated rendered version of the user provided payload data (ParameterVersionPayload) which has substitutions of all (if any) references to a SecretManager SecretVersion resources. This substitution only works for a Parameter which is in JSON or YAML format. } diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index aadac9ed23..f602659601 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -235,6 +235,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://parametermanager.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.ca.rep.googleapis.com/", +"location": "ca" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.in.rep.googleapis.com/", +"location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -1227,7 +1237,7 @@ } } }, -"revision": "20260629", +"revision": "20260831", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { @@ -1434,6 +1444,13 @@ "description": "Output only. [Output-only] policy member strings of a Google Cloud resource.", "readOnly": true }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `\"\" : \"\"`. For example, a single resource can have the following tags: ``` \"123/environment\": \"production\", \"123/costCenter\": \"marketing\", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource.", +"type": "object" +}, "updateTime": { "description": "Output only. [Output only] Update time stamp", "format": "google-datetime", @@ -1447,6 +1464,21 @@ "description": "Message describing ParameterVersion resource", "id": "ParameterVersion", "properties": { +"checksumSource": { +"description": "Optional. Output only. [Output only] The source of the checksum.", +"enum": [ +"CHECKSUM_SOURCE_UNSPECIFIED", +"SERVER_GENERATED", +"USER_SPECIFIED" +], +"enumDescriptions": [ +"The default / unset value.", +"The checksum was generated by the server.", +"The checksum was provided by the user." +], +"readOnly": true, +"type": "string" +}, "createTime": { "description": "Output only. [Output only] Create time stamp", "format": "google-datetime", @@ -1487,6 +1519,11 @@ "description": "Required. bytes data for storing payload.", "format": "byte", "type": "string" +}, +"dataCrc32c": { +"description": "Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum.", +"format": "int64", +"type": "string" } }, "type": "object" From 362e10661c5ae0a0225a386ee3c0ad074df54809 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:18 +0000 Subject: [PATCH 32/40] feat(pubsub): update the api #### pubsub:v1 The following keys were added: - schemas.CompiledProtoSchema (Total Keys: 5) - schemas.Schema.properties.compiledProtoSchema.$ref (Total Keys: 1) --- docs/dyn/pubsub_v1.projects.schemas.html | 44 +++++++++++++++++++ .../discovery_cache/documents/pubsub.v1.json | 22 +++++++++- 2 files changed, 65 insertions(+), 1 deletion(-) diff --git a/docs/dyn/pubsub_v1.projects.schemas.html b/docs/dyn/pubsub_v1.projects.schemas.html index 2aa5e726bd..8a7509cbf0 100644 --- a/docs/dyn/pubsub_v1.projects.schemas.html +++ b/docs/dyn/pubsub_v1.projects.schemas.html @@ -139,6 +139,10 @@

Method Details

{ # Request for CommitSchema method. "schema": { # A schema resource. # Required. The schema revision to commit. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -156,6 +160,10 @@

Method Details

An object of the form: { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -174,6 +182,10 @@

Method Details

The object takes the form of: { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -191,6 +203,10 @@

Method Details

An object of the form: { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -233,6 +249,10 @@

Method Details

An object of the form: { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -261,6 +281,10 @@

Method Details

An object of the form: { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -329,6 +353,10 @@

Method Details

"nextPageToken": "A String", # If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new `ListSchemasRequest`. "schemas": [ # The resulting schemas. { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -364,6 +392,10 @@

Method Details

"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. "schemas": [ # The revisions of the schema. { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -424,6 +456,10 @@

Method Details

An object of the form: { # A schema resource. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -531,6 +567,10 @@

Method Details

{ # Request for the `ValidateSchema` method. "schema": { # A schema resource. # Required. The schema object to validate. + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. @@ -565,6 +605,10 @@

Method Details

"message": "A String", # Message to validate against the provided `schema_spec`. "name": "A String", # Name of the schema against which to validate. Format is `projects/{project}/schemas/{schema}`. "schema": { # A schema resource. # Ad-hoc schema against which to validate + "compiledProtoSchema": { # Configuration specific to compiled Protocol Buffer schemas. # Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER. + "compiledBytes": "A String", # Required. The compiled FileDescriptorSet binary. + "rootMessage": "A String", # Required. The name of the root message type in the schema. + }, "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. "revisionCreateTime": "A String", # Output only. The timestamp that the revision was created. diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index aad691ee2c..6d437545cf 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1798,7 +1798,7 @@ } } }, -"revision": "20260716", +"revision": "20260825", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AIInference": { @@ -2287,6 +2287,22 @@ }, "type": "object" }, +"CompiledProtoSchema": { +"description": "Configuration specific to compiled Protocol Buffer schemas.", +"id": "CompiledProtoSchema", +"properties": { +"compiledBytes": { +"description": "Required. The compiled FileDescriptorSet binary.", +"format": "byte", +"type": "string" +}, +"rootMessage": { +"description": "Required. The name of the root message type in the schema.", +"type": "string" +} +}, +"type": "object" +}, "Compression": { "description": "Configuration for compressing/decompressing message data using a user-specified compression algorithm.", "id": "Compression", @@ -2970,6 +2986,10 @@ "description": "A schema resource.", "id": "Schema", "properties": { +"compiledProtoSchema": { +"$ref": "CompiledProtoSchema", +"description": "Optional. Configuration for a schema provided as a pre-compiled Protocol Buffer FileDescriptorSet. The `type` field above must be set to PROTOCOL_BUFFER." +}, "definition": { "description": "The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`.", "type": "string" From 9841b5f02e30e5d8f21aea4161df8f4d2c5217be Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:18 +0000 Subject: [PATCH 33/40] feat(run): update the api #### run:v2 The following keys were deleted: - resources.projects.resources.locations.resources.sourceUploads.methods.upload.mediaUpload.protocols.resumable (Total Keys: 2) - schemas.GoogleCloudRunV2Service.properties.durableExecution.type (Total Keys: 1) --- .../run_v2.projects.locations.instances.html | 16 +++++++-------- ...v2.projects.locations.jobs.executions.html | 8 ++++---- ...jects.locations.jobs.executions.tasks.html | 8 ++++---- docs/dyn/run_v2.projects.locations.jobs.html | 16 +++++++-------- .../run_v2.projects.locations.services.html | 20 ++++++++----------- ...projects.locations.services.revisions.html | 8 ++++---- ...run_v2.projects.locations.workerPools.html | 16 +++++++-------- ...jects.locations.workerPools.revisions.html | 8 ++++---- .../discovery_cache/documents/run.v2.json | 14 +++---------- 9 files changed, 51 insertions(+), 63 deletions(-) diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index b909b6f060..6730084223 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -245,13 +245,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -593,13 +593,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -927,13 +927,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -1220,13 +1220,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 5d5f9603de..3dff0cb981 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -371,13 +371,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -638,13 +638,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index 134535a57a..afd56bcdb0 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -214,13 +214,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -486,13 +486,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 1118eb9e10..3c7f1fec6e 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -279,13 +279,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -637,13 +637,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -981,13 +981,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -1284,13 +1284,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 7cb34a371b..c80e5db36a 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -169,7 +169,6 @@

Method Details

"defaultUriDisabled": True or False, # Optional. Disables public resolution of the default URI of this service. "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request. "description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. - "durableExecution": True or False, # Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. @@ -296,13 +295,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -585,7 +584,6 @@

Method Details

"defaultUriDisabled": True or False, # Optional. Disables public resolution of the default URI of this service. "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request. "description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. - "durableExecution": True or False, # Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. @@ -712,13 +710,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -988,7 +986,6 @@

Method Details

"defaultUriDisabled": True or False, # Optional. Disables public resolution of the default URI of this service. "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request. "description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. - "durableExecution": True or False, # Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. @@ -1115,13 +1112,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -1351,7 +1348,6 @@

Method Details

"defaultUriDisabled": True or False, # Optional. Disables public resolution of the default URI of this service. "deleteTime": "A String", # Output only. The deletion time. It is only populated as a response to a Delete request. "description": "A String", # User-provided description of the Service. This field currently has a 512-character limit. - "durableExecution": True or False, # Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created. "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permanently deleted. "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. @@ -1478,13 +1474,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index f28c28f80e..ff7c5a632d 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -294,13 +294,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -566,13 +566,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index 6fca56132b..d94786ce16 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -282,13 +282,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -652,13 +652,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -1009,13 +1009,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -1323,13 +1323,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 24421082c9..3737e1e280 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -255,13 +255,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. @@ -527,13 +527,13 @@

Method Details

"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency. }, "sandboxLauncher": True or False, # Optional. Indicates that this container can act as a sandbox supervisor and launch sandboxes. - "sourceCode": { # Source type for the container. # Optional. Location of the source. + "sourceCode": { # Source type for the container. # Optional. Location of the source. This field is only supported in Cloud Run Service. "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket. "bucket": "A String", # Required. The Cloud Storage bucket name. "generation": "A String", # Optional. The Cloud Storage object generation. "object": "A String", # Required. The Cloud Storage object name. }, - "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. + "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service. "sources": [ # Required. Input only. The source code. { # Source file. "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application. diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 31718b27d2..9bedf543b9 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -2228,10 +2228,6 @@ ], "maxSize": "262144000", "protocols": { -"resumable": { -"multipart": true, -"path": "/resumable/upload/v2/{+parent}:uploadSource" -}, "simple": { "multipart": true, "path": "/upload/v2/{+parent}:uploadSource" @@ -2673,7 +2669,7 @@ } } }, -"revision": "20260814", +"revision": "20260828", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -3095,7 +3091,7 @@ }, "sourceCode": { "$ref": "GoogleCloudRunV2SourceCode", -"description": "Optional. Location of the source." +"description": "Optional. Location of the source. This field is only supported in Cloud Run Service." }, "startupProbe": { "$ref": "GoogleCloudRunV2Probe", @@ -5019,10 +5015,6 @@ "description": "User-provided description of the Service. This field currently has a 512-character limit.", "type": "string" }, -"durableExecution": { -"description": "Optional. Immutable. Indicates whether the Service has durable execution enabled. This field is immutable once the Service is created.", -"type": "boolean" -}, "etag": { "description": "Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.", "type": "string" @@ -5256,7 +5248,7 @@ }, "inlinedSource": { "$ref": "GoogleCloudRunV2InlinedSource", -"description": "Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source." +"description": "Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source. This field is only supported in Cloud Run Service." } }, "type": "object" From ea03af86493a911ff99da4b667ed539e6ba57ea3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:18 +0000 Subject: [PATCH 34/40] feat(sqladmin): update the api #### sqladmin:v1beta4 The following keys were added: - resources.blueGreenDeployments.methods.create (Total Keys: 14) - resources.blueGreenDeployments.methods.delete (Total Keys: 13) - resources.blueGreenDeployments.methods.get (Total Keys: 13) - resources.blueGreenDeployments.methods.list (Total Keys: 20) - resources.blueGreenDeployments.methods.switchover (Total Keys: 12) - resources.databases.methods.delete.parameters.location (Total Keys: 2) - resources.databases.methods.get.parameters.location (Total Keys: 2) - resources.databases.methods.insert.parameters.location (Total Keys: 2) - resources.databases.methods.list.parameters.location (Total Keys: 2) - resources.databases.methods.patch.parameters.location (Total Keys: 2) - resources.databases.methods.update.parameters.location (Total Keys: 2) - resources.instances.methods.ListEntraIdCertificates.parameters.location (Total Keys: 2) - resources.instances.methods.ListServerCertificates.parameters.location (Total Keys: 2) - resources.instances.methods.RotateEntraIdCertificate.parameters.location (Total Keys: 2) - resources.instances.methods.RotateServerCertificate.parameters.location (Total Keys: 2) - resources.instances.methods.acquireSsrsLease.parameters.location (Total Keys: 2) - resources.instances.methods.addEntraIdCertificate.parameters.location (Total Keys: 2) - resources.instances.methods.addServerCa.parameters.location (Total Keys: 2) - resources.instances.methods.addServerCertificate.parameters.location (Total Keys: 2) - resources.instances.methods.clone.parameters.location (Total Keys: 2) - resources.instances.methods.delete.parameters.location (Total Keys: 2) - resources.instances.methods.demote.parameters.location (Total Keys: 2) - resources.instances.methods.demoteMaster.parameters.location (Total Keys: 2) - resources.instances.methods.executeSql.parameters.location (Total Keys: 2) - resources.instances.methods.export.parameters.location (Total Keys: 2) - resources.instances.methods.failover.parameters.location (Total Keys: 2) - resources.instances.methods.get.parameters.location (Total Keys: 2) - resources.instances.methods.import.parameters.location (Total Keys: 2) - resources.instances.methods.insert.parameters.location (Total Keys: 2) - resources.instances.methods.list.parameters.location (Total Keys: 2) - resources.instances.methods.listServerCas.parameters.location (Total Keys: 2) - resources.instances.methods.patch.parameters.location (Total Keys: 2) - resources.instances.methods.preCheckMajorVersionUpgrade.parameters.location (Total Keys: 2) - resources.instances.methods.promoteReplica.parameters.location (Total Keys: 2) - resources.instances.methods.reencrypt.parameters.location (Total Keys: 2) - resources.instances.methods.releaseSsrsLease.parameters.location (Total Keys: 2) - resources.instances.methods.resetSslConfig.parameters.location (Total Keys: 2) - resources.instances.methods.restart.parameters.location (Total Keys: 2) - resources.instances.methods.restoreBackup.parameters.location (Total Keys: 2) - resources.instances.methods.rotateServerCa.parameters.location (Total Keys: 2) - resources.instances.methods.startReplica.parameters.location (Total Keys: 2) - resources.instances.methods.stopReplica.parameters.location (Total Keys: 2) - resources.instances.methods.switchover.parameters.location (Total Keys: 2) - resources.instances.methods.truncateLog.parameters.location (Total Keys: 2) - resources.instances.methods.update.parameters.location (Total Keys: 2) - resources.projects.resources.instances.methods.getDiskShrinkConfig.parameters.location (Total Keys: 2) - resources.projects.resources.instances.methods.getLatestRecoveryTime.parameters.location (Total Keys: 2) - resources.projects.resources.instances.methods.performDiskShrink.parameters.location (Total Keys: 2) - resources.projects.resources.instances.methods.rescheduleMaintenance.parameters.location (Total Keys: 2) - resources.sslCerts.methods.createEphemeral.parameters.location (Total Keys: 2) - resources.users.methods.delete.parameters.location (Total Keys: 2) - resources.users.methods.get.parameters.location (Total Keys: 2) - resources.users.methods.insert.parameters.location (Total Keys: 2) - resources.users.methods.list.parameters.location (Total Keys: 2) - resources.users.methods.update.parameters.location (Total Keys: 2) - schemas.BlueGreenDeployment (Total Keys: 36) - schemas.ConfigDiff (Total Keys: 8) - schemas.DatabaseInstance.properties.deploymentInfo (Total Keys: 2) - schemas.DeploymentTask (Total Keys: 19) - schemas.DiskEncryptionConfiguration.properties.confidentialMode.type (Total Keys: 1) - schemas.InstancesRestoreBackupRequest.properties.ignoreMaintenanceVersion.type (Total Keys: 1) - schemas.ListBlueGreenDeploymentsResponse (Total Keys: 5) - schemas.NodeInfo (Total Keys: 11) - schemas.RequestedConfig (Total Keys: 3) - schemas.SourceRole (Total Keys: 4) - schemas.SourceTargetPairedNode (Total Keys: 17) - schemas.SqlInstancesResetReplicaSizeRequest.properties.location.type (Total Keys: 1) - schemas.SqlInstancesStartExternalSyncRequest.properties.location.type (Total Keys: 1) - schemas.SqlInstancesVerifyExternalSyncSettingsRequest.properties.location.type (Total Keys: 1) - schemas.SwitchoverBlueGreenDeploymentRequest (Total Keys: 2) - schemas.TargetConfig (Total Keys: 4) - schemas.TargetRole (Total Keys: 4) --- docs/dyn/sqladmin_v1beta4.backupRuns.html | 3 + docs/dyn/sqladmin_v1beta4.backups.html | 92 +- ...sqladmin_v1beta4.blueGreenDeployments.html | 1019 +++++++++++++++++ docs/dyn/sqladmin_v1beta4.databases.html | 30 +- docs/dyn/sqladmin_v1beta4.html | 5 + docs/dyn/sqladmin_v1beta4.instances.html | 332 ++++-- .../sqladmin_v1beta4.projects.instances.html | 23 +- docs/dyn/sqladmin_v1beta4.sslCerts.html | 5 +- docs/dyn/sqladmin_v1beta4.users.html | 41 +- .../documents/sqladmin.v1beta4.json | 904 ++++++++++++++- 10 files changed, 2314 insertions(+), 140 deletions(-) create mode 100644 docs/dyn/sqladmin_v1beta4.blueGreenDeployments.html diff --git a/docs/dyn/sqladmin_v1beta4.backupRuns.html b/docs/dyn/sqladmin_v1beta4.backupRuns.html index 76d30b5f56..76d938102e 100644 --- a/docs/dyn/sqladmin_v1beta4.backupRuns.html +++ b/docs/dyn/sqladmin_v1beta4.backupRuns.html @@ -284,6 +284,7 @@

Method Details

"databaseVersion": "A String", # Output only. The instance database version at the time this backup was made. "description": "A String", # The description of this run, only applicable to on-demand backups. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -327,6 +328,7 @@

Method Details

"databaseVersion": "A String", # Output only. The instance database version at the time this backup was made. "description": "A String", # The description of this run, only applicable to on-demand backups. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -535,6 +537,7 @@

Method Details

"databaseVersion": "A String", # Output only. The instance database version at the time this backup was made. "description": "A String", # The description of this run, only applicable to on-demand backups. "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Encryption configuration specific to a backup. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html index 99fe4a88cf..6b6ea518fd 100644 --- a/docs/dyn/sqladmin_v1beta4.backups.html +++ b/docs/dyn/sqladmin_v1beta4.backups.html @@ -138,7 +138,26 @@

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -414,7 +433,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -452,7 +471,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -907,7 +926,26 @@

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -1183,7 +1221,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -1221,7 +1259,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -1362,7 +1400,26 @@

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -1638,7 +1695,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -1676,7 +1733,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -1831,7 +1888,26 @@

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -2107,7 +2183,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -2145,7 +2221,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. diff --git a/docs/dyn/sqladmin_v1beta4.blueGreenDeployments.html b/docs/dyn/sqladmin_v1beta4.blueGreenDeployments.html new file mode 100644 index 0000000000..1fe02032b9 --- /dev/null +++ b/docs/dyn/sqladmin_v1beta4.blueGreenDeployments.html @@ -0,0 +1,1019 @@ + + + +

Cloud SQL Admin API . blueGreenDeployments

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, blueGreenDeploymentId=None, body=None, x__xgafv=None)

+

Creates a blue-green deployment under a given project and location. This deployment provisions a synchronized green environment (target instance) from a blue production environment (source instance), facilitating updates like major version upgrades on the green instance without impacting the blue instance.

+

+ delete(name, deleteOldSource=None, x__xgafv=None)

+

Deletes a blue-green deployment, including metadata and underlying resources based on the deployment state. If issued before switchover, this deletes the green instance. If issued after switchover, this deletes the old blue instance (source instance) if the `delete_old_source` field in the request is set to true. All blue-green deployment metadata is permanently deleted. Resources deleted as a result of this operation are no longer accessible and can't be restored.

+

+ get(name, view=None, x__xgafv=None)

+

Retrieves a blue-green deployment resource under a given project and location.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists blue-green deployments under a given project.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ switchover(name, body=None, x__xgafv=None)

+

Switches over to green instance for a blue-green deployment.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, blueGreenDeploymentId=None, body=None, x__xgafv=None) +
Creates a blue-green deployment under a given project and location. This deployment provisions a synchronized green environment (target instance) from a blue production environment (source instance), facilitating updates like major version upgrades on the green instance without impacting the blue instance.
+
+Args:
+  parent: string, Required. The parent resource where this blue-green deployment will be created. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment setup. It orchestrates the lifecycle of creating a synchronized "green" environment from a "blue" production environment, performing updates, and managing the switchover process to minimize downtime.
+  "createTime": "A String", # Output only. The time when the deployment was created.
+  "deploymentMappings": [ # Output only. A list representing the pairs of source and target instances in the deployment.
+    { # Represents a pairing of a source instance node and a target instance node.
+      "currentlyServingTraffic": "A String", # Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.
+      "diffs": [ # Output only. Describes the list of differences for this pair.
+        { # Represents a specific configuration difference between Blue and Green instances.
+          "field": "A String", # Output only. The name of the field that differs, fully-qualified. Example: settings.tier
+          "sourceValue": "A String", # Output only. The value on the source instance.
+          "targetValue": "A String", # Output only. The value on the target instance.
+        },
+      ],
+      "source": { # Details about an instance within the deployment. # Output only. Resource name of the source instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "state": "A String", # Output only. The current state of this specific source-target pair.
+      "target": { # Details about an instance within the deployment. # Output only. Details of the corresponding target instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "tasks": [ # Output only. Tasks performed or being performed on the target instance of this pair.
+        { # Represents a task executed as part of the deployment on a target instance.
+          "endTime": "A String", # Output only. Task end time (if completed).
+          "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+          "startTime": "A String", # Output only. Task start time.
+          "state": "A String", # Output only. The current state of the task.
+          "type": "A String", # Output only. The type of the task.
+        },
+      ],
+    },
+  ],
+  "deploymentTasks": { # Combined list of tasks for all paired nodes in the deployment. # Output only. Combined list of tasks for all paired nodes.
+    "task": [ # Output only. Tasks performed or being performed on the paired nodes of the deployment at a consolidated level.
+      { # Represents a task executed as part of the deployment on a target instance.
+        "endTime": "A String", # Output only. Task end time (if completed).
+        "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+        "startTime": "A String", # Output only. Task start time.
+        "state": "A String", # Output only. The current state of the task.
+        "type": "A String", # Output only. The type of the task.
+      },
+    ],
+  },
+  "description": "A String", # Optional. User-provided description for the deployment.
+  "errorDetail": "A String", # Output only. Provides an error message with details on why switchover is not possible.
+  "name": "A String", # Output only. Identifier. The full resource name of the deployment. Format: projects/{project}/locations/{location}/blueGreenDeployments/{deployment_id}
+  "pairedNodes": [ # Output only. Deprecated: Use deployment_mappings instead. Output only. A list representing the pairs of source and target instances in the deployment.
+    { # Represents a pairing of a source instance node and a target instance node.
+      "currentlyServingTraffic": "A String", # Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.
+      "diffs": [ # Output only. Describes the list of differences for this pair.
+        { # Represents a specific configuration difference between Blue and Green instances.
+          "field": "A String", # Output only. The name of the field that differs, fully-qualified. Example: settings.tier
+          "sourceValue": "A String", # Output only. The value on the source instance.
+          "targetValue": "A String", # Output only. The value on the target instance.
+        },
+      ],
+      "source": { # Details about an instance within the deployment. # Output only. Resource name of the source instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "state": "A String", # Output only. The current state of this specific source-target pair.
+      "target": { # Details about an instance within the deployment. # Output only. Details of the corresponding target instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "tasks": [ # Output only. Tasks performed or being performed on the target instance of this pair.
+        { # Represents a task executed as part of the deployment on a target instance.
+          "endTime": "A String", # Output only. Task end time (if completed).
+          "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+          "startTime": "A String", # Output only. Task start time.
+          "state": "A String", # Output only. The current state of the task.
+          "type": "A String", # Output only. The type of the task.
+        },
+      ],
+    },
+  ],
+  "requestedConfig": { # Configuration specified by the user at creation time for the target (Green) instance. # Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created.
+    "databaseVersion": "A String", # Optional. The target database major version for the upgrade.
+  },
+  "sourceInstance": "A String", # Required. Immutable. The instance ID of the source instance (the "blue" instance). The value for this field does not include the project ID, for example, `my-instance-id`. This field is immutable.
+  "state": "A String", # Output only. The current state of the blue-green deployment.
+  "switchoverTargetInstance": "A String", # Output only. Details about the primary target instance (the "Green" instance) that will be promoted during switchover.
+  "targetConfig": { # Deprecated: Use RequestedConfig instead. Configuration specified by the user at creation time for the target (Green) instance. # Optional. Immutable. Deprecated: Use requested_config instead. The configuration intended for the target instance(s) when the deployment was created. This field is immutable.
+    "databaseVersion": "A String", # Optional. The target database major version for the upgrade.
+  },
+}
+
+  blueGreenDeploymentId: string, Required. The ID to use for the blue-green deployment, which will become the final component of the deployment's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for the SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for the SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+    "name": "A String", # The name of the backup. Format: projects/{project}/backups/{backup}
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Whether to perform a serverless export.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "tdeExportOptions": { # Optional. Export parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF.
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "keepEncrypted": True or False, # Optional. Whether the imported file remains encrypted.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "tdeImportOptions": { # Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "subOperationType": { # The sub operation type based on the operation type. # Optional. The sub operation based on the operation type.
+    "maintenanceType": "A String", # The type of maintenance to be performed on the instance.
+  },
+  "targetId": "A String", # Name of the resource on which this operation runs.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+ +
+ delete(name, deleteOldSource=None, x__xgafv=None) +
Deletes a blue-green deployment, including metadata and underlying resources based on the deployment state. If issued before switchover, this deletes the green instance. If issued after switchover, this deletes the old blue instance (source instance) if the `delete_old_source` field in the request is set to true. All blue-green deployment metadata is permanently deleted. Resources deleted as a result of this operation are no longer accessible and can't be restored.
+
+Args:
+  name: string, Required. The name of the blue-green deployment to delete. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment} (required)
+  deleteOldSource: boolean, Optional. If set to true, and the switchover is complete, this deletes the old source instance along with the deployment.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for the SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for the SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+    "name": "A String", # The name of the backup. Format: projects/{project}/backups/{backup}
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Whether to perform a serverless export.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "tdeExportOptions": { # Optional. Export parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF.
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "keepEncrypted": True or False, # Optional. Whether the imported file remains encrypted.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "tdeImportOptions": { # Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "subOperationType": { # The sub operation type based on the operation type. # Optional. The sub operation based on the operation type.
+    "maintenanceType": "A String", # The type of maintenance to be performed on the instance.
+  },
+  "targetId": "A String", # Name of the resource on which this operation runs.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Retrieves a blue-green deployment resource under a given project and location.
+
+Args:
+  name: string, Required. The name of the blue-green deployment to retrieve. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment} (required)
+  view: string, Optional. Specifies whether to return the basic or detailed view of the resource in the response.
+    Allowed values
+      BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED - Blue-green deployment view enumeration. This allows the caller to specify what view they query. If unspecified (BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED), the behavior is the same as BASIC.
+      BASIC - Includes basic metadata about the blue-green deployment. `BASIC` is the default view.
+      DETAILED - Includes basic metadata and configuration differences between source and target instances (`database_version`, `tier`, `edition`, `availability_type`, `data_disk_size_gb`, and `data_disk_type`).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment setup. It orchestrates the lifecycle of creating a synchronized "green" environment from a "blue" production environment, performing updates, and managing the switchover process to minimize downtime.
+  "createTime": "A String", # Output only. The time when the deployment was created.
+  "deploymentMappings": [ # Output only. A list representing the pairs of source and target instances in the deployment.
+    { # Represents a pairing of a source instance node and a target instance node.
+      "currentlyServingTraffic": "A String", # Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.
+      "diffs": [ # Output only. Describes the list of differences for this pair.
+        { # Represents a specific configuration difference between Blue and Green instances.
+          "field": "A String", # Output only. The name of the field that differs, fully-qualified. Example: settings.tier
+          "sourceValue": "A String", # Output only. The value on the source instance.
+          "targetValue": "A String", # Output only. The value on the target instance.
+        },
+      ],
+      "source": { # Details about an instance within the deployment. # Output only. Resource name of the source instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "state": "A String", # Output only. The current state of this specific source-target pair.
+      "target": { # Details about an instance within the deployment. # Output only. Details of the corresponding target instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "tasks": [ # Output only. Tasks performed or being performed on the target instance of this pair.
+        { # Represents a task executed as part of the deployment on a target instance.
+          "endTime": "A String", # Output only. Task end time (if completed).
+          "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+          "startTime": "A String", # Output only. Task start time.
+          "state": "A String", # Output only. The current state of the task.
+          "type": "A String", # Output only. The type of the task.
+        },
+      ],
+    },
+  ],
+  "deploymentTasks": { # Combined list of tasks for all paired nodes in the deployment. # Output only. Combined list of tasks for all paired nodes.
+    "task": [ # Output only. Tasks performed or being performed on the paired nodes of the deployment at a consolidated level.
+      { # Represents a task executed as part of the deployment on a target instance.
+        "endTime": "A String", # Output only. Task end time (if completed).
+        "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+        "startTime": "A String", # Output only. Task start time.
+        "state": "A String", # Output only. The current state of the task.
+        "type": "A String", # Output only. The type of the task.
+      },
+    ],
+  },
+  "description": "A String", # Optional. User-provided description for the deployment.
+  "errorDetail": "A String", # Output only. Provides an error message with details on why switchover is not possible.
+  "name": "A String", # Output only. Identifier. The full resource name of the deployment. Format: projects/{project}/locations/{location}/blueGreenDeployments/{deployment_id}
+  "pairedNodes": [ # Output only. Deprecated: Use deployment_mappings instead. Output only. A list representing the pairs of source and target instances in the deployment.
+    { # Represents a pairing of a source instance node and a target instance node.
+      "currentlyServingTraffic": "A String", # Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.
+      "diffs": [ # Output only. Describes the list of differences for this pair.
+        { # Represents a specific configuration difference between Blue and Green instances.
+          "field": "A String", # Output only. The name of the field that differs, fully-qualified. Example: settings.tier
+          "sourceValue": "A String", # Output only. The value on the source instance.
+          "targetValue": "A String", # Output only. The value on the target instance.
+        },
+      ],
+      "source": { # Details about an instance within the deployment. # Output only. Resource name of the source instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "state": "A String", # Output only. The current state of this specific source-target pair.
+      "target": { # Details about an instance within the deployment. # Output only. Details of the corresponding target instance in this pair.
+        "connection": "A String", # Output only. The instance connection name.
+        "dns": "A String", # Output only. The unique DNS name for this instance.
+        "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+        "ipMappings": [ # Output only. The list of IP addresses for this instance.
+          { # Database instance IP mapping
+            "ipAddress": "A String", # The IP address assigned.
+            "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+            "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+          },
+        ],
+      },
+      "tasks": [ # Output only. Tasks performed or being performed on the target instance of this pair.
+        { # Represents a task executed as part of the deployment on a target instance.
+          "endTime": "A String", # Output only. Task end time (if completed).
+          "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+          "startTime": "A String", # Output only. Task start time.
+          "state": "A String", # Output only. The current state of the task.
+          "type": "A String", # Output only. The type of the task.
+        },
+      ],
+    },
+  ],
+  "requestedConfig": { # Configuration specified by the user at creation time for the target (Green) instance. # Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created.
+    "databaseVersion": "A String", # Optional. The target database major version for the upgrade.
+  },
+  "sourceInstance": "A String", # Required. Immutable. The instance ID of the source instance (the "blue" instance). The value for this field does not include the project ID, for example, `my-instance-id`. This field is immutable.
+  "state": "A String", # Output only. The current state of the blue-green deployment.
+  "switchoverTargetInstance": "A String", # Output only. Details about the primary target instance (the "Green" instance) that will be promoted during switchover.
+  "targetConfig": { # Deprecated: Use RequestedConfig instead. Configuration specified by the user at creation time for the target (Green) instance. # Optional. Immutable. Deprecated: Use requested_config instead. The configuration intended for the target instance(s) when the deployment was created. This field is immutable.
+    "databaseVersion": "A String", # Optional. The target database major version for the upgrade.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists blue-green deployments under a given project.
+
+Args:
+  parent: string, Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters the results.
+  orderBy: string, Optional. A comma-separated list of fields to order the results by.
+  pageSize: integer, Optional. The maximum number of deployments to return.
+  pageToken: string, Optional. A page token, received from a previous `ListBlueGreenDeployments` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for listing blue-green deployment resources.
+  "blueGreenDeployments": [ # The list of blue-green deployment resources.
+    { # A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment setup. It orchestrates the lifecycle of creating a synchronized "green" environment from a "blue" production environment, performing updates, and managing the switchover process to minimize downtime.
+      "createTime": "A String", # Output only. The time when the deployment was created.
+      "deploymentMappings": [ # Output only. A list representing the pairs of source and target instances in the deployment.
+        { # Represents a pairing of a source instance node and a target instance node.
+          "currentlyServingTraffic": "A String", # Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.
+          "diffs": [ # Output only. Describes the list of differences for this pair.
+            { # Represents a specific configuration difference between Blue and Green instances.
+              "field": "A String", # Output only. The name of the field that differs, fully-qualified. Example: settings.tier
+              "sourceValue": "A String", # Output only. The value on the source instance.
+              "targetValue": "A String", # Output only. The value on the target instance.
+            },
+          ],
+          "source": { # Details about an instance within the deployment. # Output only. Resource name of the source instance in this pair.
+            "connection": "A String", # Output only. The instance connection name.
+            "dns": "A String", # Output only. The unique DNS name for this instance.
+            "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+            "ipMappings": [ # Output only. The list of IP addresses for this instance.
+              { # Database instance IP mapping
+                "ipAddress": "A String", # The IP address assigned.
+                "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+                "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+              },
+            ],
+          },
+          "state": "A String", # Output only. The current state of this specific source-target pair.
+          "target": { # Details about an instance within the deployment. # Output only. Details of the corresponding target instance in this pair.
+            "connection": "A String", # Output only. The instance connection name.
+            "dns": "A String", # Output only. The unique DNS name for this instance.
+            "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+            "ipMappings": [ # Output only. The list of IP addresses for this instance.
+              { # Database instance IP mapping
+                "ipAddress": "A String", # The IP address assigned.
+                "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+                "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+              },
+            ],
+          },
+          "tasks": [ # Output only. Tasks performed or being performed on the target instance of this pair.
+            { # Represents a task executed as part of the deployment on a target instance.
+              "endTime": "A String", # Output only. Task end time (if completed).
+              "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+              "startTime": "A String", # Output only. Task start time.
+              "state": "A String", # Output only. The current state of the task.
+              "type": "A String", # Output only. The type of the task.
+            },
+          ],
+        },
+      ],
+      "deploymentTasks": { # Combined list of tasks for all paired nodes in the deployment. # Output only. Combined list of tasks for all paired nodes.
+        "task": [ # Output only. Tasks performed or being performed on the paired nodes of the deployment at a consolidated level.
+          { # Represents a task executed as part of the deployment on a target instance.
+            "endTime": "A String", # Output only. Task end time (if completed).
+            "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+            "startTime": "A String", # Output only. Task start time.
+            "state": "A String", # Output only. The current state of the task.
+            "type": "A String", # Output only. The type of the task.
+          },
+        ],
+      },
+      "description": "A String", # Optional. User-provided description for the deployment.
+      "errorDetail": "A String", # Output only. Provides an error message with details on why switchover is not possible.
+      "name": "A String", # Output only. Identifier. The full resource name of the deployment. Format: projects/{project}/locations/{location}/blueGreenDeployments/{deployment_id}
+      "pairedNodes": [ # Output only. Deprecated: Use deployment_mappings instead. Output only. A list representing the pairs of source and target instances in the deployment.
+        { # Represents a pairing of a source instance node and a target instance node.
+          "currentlyServingTraffic": "A String", # Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.
+          "diffs": [ # Output only. Describes the list of differences for this pair.
+            { # Represents a specific configuration difference between Blue and Green instances.
+              "field": "A String", # Output only. The name of the field that differs, fully-qualified. Example: settings.tier
+              "sourceValue": "A String", # Output only. The value on the source instance.
+              "targetValue": "A String", # Output only. The value on the target instance.
+            },
+          ],
+          "source": { # Details about an instance within the deployment. # Output only. Resource name of the source instance in this pair.
+            "connection": "A String", # Output only. The instance connection name.
+            "dns": "A String", # Output only. The unique DNS name for this instance.
+            "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+            "ipMappings": [ # Output only. The list of IP addresses for this instance.
+              { # Database instance IP mapping
+                "ipAddress": "A String", # The IP address assigned.
+                "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+                "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+              },
+            ],
+          },
+          "state": "A String", # Output only. The current state of this specific source-target pair.
+          "target": { # Details about an instance within the deployment. # Output only. Details of the corresponding target instance in this pair.
+            "connection": "A String", # Output only. The instance connection name.
+            "dns": "A String", # Output only. The unique DNS name for this instance.
+            "instance": "A String", # Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}
+            "ipMappings": [ # Output only. The list of IP addresses for this instance.
+              { # Database instance IP mapping
+                "ipAddress": "A String", # The IP address assigned.
+                "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. This field is only available when the IP is scheduled to be retired.
+                "type": "A String", # The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported.
+              },
+            ],
+          },
+          "tasks": [ # Output only. Tasks performed or being performed on the target instance of this pair.
+            { # Represents a task executed as part of the deployment on a target instance.
+              "endTime": "A String", # Output only. Task end time (if completed).
+              "errorMessage": "A String", # Output only. Optional Error details if the task state is FAILED.
+              "startTime": "A String", # Output only. Task start time.
+              "state": "A String", # Output only. The current state of the task.
+              "type": "A String", # Output only. The type of the task.
+            },
+          ],
+        },
+      ],
+      "requestedConfig": { # Configuration specified by the user at creation time for the target (Green) instance. # Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created.
+        "databaseVersion": "A String", # Optional. The target database major version for the upgrade.
+      },
+      "sourceInstance": "A String", # Required. Immutable. The instance ID of the source instance (the "blue" instance). The value for this field does not include the project ID, for example, `my-instance-id`. This field is immutable.
+      "state": "A String", # Output only. The current state of the blue-green deployment.
+      "switchoverTargetInstance": "A String", # Output only. Details about the primary target instance (the "Green" instance) that will be promoted during switchover.
+      "targetConfig": { # Deprecated: Use RequestedConfig instead. Configuration specified by the user at creation time for the target (Green) instance. # Optional. Immutable. Deprecated: Use requested_config instead. The configuration intended for the target instance(s) when the deployment was created. This field is immutable.
+        "databaseVersion": "A String", # Optional. The target database major version for the upgrade.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results.
+}
+
+ +
+ 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.
+
+
+ +
+ switchover(name, body=None, x__xgafv=None) +
Switches over to green instance for a blue-green deployment.
+
+Args:
+  name: string, Required. The name of the blue-green deployment to switch over. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for switching over a `BlueGreenDeployment` resource.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
+  "acquireSsrsLeaseContext": { # Acquire SSRS lease context. # The context for acquire SSRS lease operation, if applicable.
+    "duration": "A String", # Lease duration needed for the SSRS setup.
+    "reportDatabase": "A String", # The report database to be used for the SSRS setup.
+    "serviceLogin": "A String", # The username to be used as the service login to connect to the report database for SSRS setup.
+    "setupLogin": "A String", # The username to be used as the setup login to connect to the database server for SSRS setup.
+  },
+  "apiWarning": { # An Admin API warning message. # An Admin API warning message.
+    "code": "A String", # Code to uniquely identify the warning type.
+    "message": "A String", # The warning message.
+    "region": "A String", # The region name for REGION_UNREACHABLE warning.
+  },
+  "backupContext": { # Backup context. # The context for backup operation, if applicable.
+    "backupId": "A String", # The identifier of the backup.
+    "kind": "A String", # This is always `sql#backupContext`.
+    "name": "A String", # The name of the backup. Format: projects/{project}/backups/{backup}
+  },
+  "endTime": "A String", # The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
+    "errors": [ # The list of errors encountered while processing this operation.
+      { # Database instance operation error.
+        "code": "A String", # Identifies the specific error that occurred.
+        "kind": "A String", # This is always `sql#operationError`.
+        "message": "A String", # Additional information about the error encountered.
+      },
+    ],
+    "kind": "A String", # This is always `sql#operationErrors`.
+  },
+  "exportContext": { # Database instance export context. # The context for export operation, if applicable.
+    "bakExportOptions": { # Options for exporting BAK files (SQL Server-only)
+      "bakType": "A String", # Type of this bak file will be export, FULL or DIFF, SQL Server only
+      "copyOnly": True or False, # Deprecated: copy_only is deprecated. Use differential_base instead
+      "differentialBase": True or False, # Whether or not the backup can be used as a differential base copy_only backup can not be served as differential base
+      "exportLogEndTime": "A String", # Optional. The end timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs until current time will be included. Only applied to Cloud SQL for SQL Server.
+      "exportLogStartTime": "A String", # Optional. The begin timestamp when transaction log will be included in the export operation. [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`) in UTC. When omitted, all available logs from the beginning of retention period will be included. Only applied to Cloud SQL for SQL Server.
+      "stripeCount": 42, # Option for specifying how many stripes to use for the export. If blank, and the value of the striped field is true, the number of stripes is automatically chosen.
+      "striped": True or False, # Whether or not the export should be striped.
+    },
+    "csvExportOptions": { # Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "selectQuery": "A String", # The select query used to extract the data.
+    },
+    "databases": [ # Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
+      "A String",
+    ],
+    "fileType": "A String", # The file type for the specified uri.
+    "kind": "A String", # This is always `sql#exportContext`.
+    "offload": True or False, # Whether to perform a serverless export.
+    "sqlExportOptions": { # Options for exporting data as SQL statements.
+      "mysqlExportOptions": { # Options for exporting from MySQL.
+        "masterData": 42, # Option to include SQL statement required to set up replication. If set to `1`, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to `2`, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than `1`, --set-gtid-purged is set to OFF.
+      },
+      "parallel": True or False, # Optional. Whether or not the export should be parallel.
+      "postgresExportOptions": { # Options for exporting from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation.
+        "ifExists": True or False, # Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.
+      },
+      "schemaOnly": True or False, # Export only schemas.
+      "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database. For PostgreSQL instances, you can specify only one table.
+        "A String",
+      ],
+      "threads": 42, # Optional. The number of threads to use for parallel export.
+    },
+    "tdeExportOptions": { # Optional. Export parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
+  },
+  "importContext": { # Database instance import context. # The context for import operation, if applicable.
+    "bakImportOptions": { # Import parameters specific to SQL Server .BAK files
+      "bakType": "A String", # Type of the bak content, FULL or DIFF.
+      "encryptionOptions": {
+        "certPath": "A String", # Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+        "keepEncrypted": True or False, # Optional. Whether the imported file remains encrypted.
+        "pvkPassword": "A String", # Password that encrypts the private key
+        "pvkPath": "A String", # Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file.
+      },
+      "noRecovery": True or False, # Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server.
+      "recoveryOnly": True or False, # Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server.
+      "stopAt": "A String", # Optional. The timestamp when the import should stop. This timestamp is in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, `2023-10-01T16:19:00.094`). This field is equivalent to the STOPAT keyword and applies to Cloud SQL for SQL Server only.
+      "stopAtMark": "A String", # Optional. The marked transaction where the import should stop. This field is equivalent to the STOPATMARK keyword and applies to Cloud SQL for SQL Server only.
+      "striped": True or False, # Whether or not the backup set being restored is striped. Applies only to Cloud SQL for SQL Server.
+    },
+    "csvImportOptions": { # Options for importing data as CSV.
+      "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
+        "A String",
+      ],
+      "escapeCharacter": "A String", # Specifies the character that should appear before a data character that needs to be escaped.
+      "fieldsTerminatedBy": "A String", # Specifies the character that separates columns within each row (line) of the file.
+      "linesTerminatedBy": "A String", # This is used to separate lines. If a line does not contain all fields, the rest of the columns are set to their default values.
+      "quoteCharacter": "A String", # Specifies the quoting character to be used when a data value is quoted.
+      "table": "A String", # The table to which CSV data is imported.
+    },
+    "database": "A String", # The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
+    "fileType": "A String", # The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance.
+    "importUser": "A String", # The PostgreSQL user for this import operation. PostgreSQL instances only.
+    "kind": "A String", # This is always `sql#importContext`.
+    "sqlImportOptions": { # Optional. Options for importing data from SQL statements.
+      "parallel": True or False, # Optional. Whether or not the import should be parallel.
+      "postgresImportOptions": { # Optional. Options for importing from a Cloud SQL for PostgreSQL instance.
+        "clean": True or False, # Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+        "ifExists": True or False, # Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.
+      },
+      "threads": 42, # Optional. The number of threads to use for parallel import.
+    },
+    "tdeImportOptions": { # Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates
+      "certificatePath": "A String", # Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+      "name": "A String", # Required. Certificate name. Applicable only for SQL Server instances.
+      "privateKeyPassword": "A String", # Required. Password that encrypts the private key.
+      "privateKeyPath": "A String", # Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances.
+    },
+    "uri": "A String", # Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
+  },
+  "insertTime": "A String", # The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "kind": "A String", # This is always `sql#operation`.
+  "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
+  "operationType": "A String", # The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE`
+  "preCheckMajorVersionUpgradeContext": { # Pre-check major version upgrade context. # The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
+    "kind": "A String", # Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.
+    "preCheckResponse": [ # Output only. The responses from the precheck operation.
+      { # Structured PreCheckResponse containing message, type, and required actions.
+        "actionsRequired": [ # The actions that the user needs to take. Use repeated for multiple actions.
+          "A String",
+        ],
+        "message": "A String", # The message to be displayed to the user.
+        "messageType": "A String", # The type of message whether it is an info, warning, or error.
+      },
+    ],
+    "targetDatabaseVersion": "A String", # Required. The target database version to upgrade to.
+  },
+  "selfLink": "A String", # The URI of this resource.
+  "startTime": "A String", # The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`.
+  "status": "A String", # The status of an operation.
+  "subOperationType": { # The sub operation type based on the operation type. # Optional. The sub operation based on the operation type.
+    "maintenanceType": "A String", # The type of maintenance to be performed on the instance.
+  },
+  "targetId": "A String", # Name of the resource on which this operation runs.
+  "targetLink": "A String",
+  "targetProject": "A String", # The project ID of the target instance related to this operation.
+  "user": "A String", # The email address of the user who initiated this operation.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/sqladmin_v1beta4.databases.html b/docs/dyn/sqladmin_v1beta4.databases.html index 3fbd216fe3..487ea90109 100644 --- a/docs/dyn/sqladmin_v1beta4.databases.html +++ b/docs/dyn/sqladmin_v1beta4.databases.html @@ -78,22 +78,22 @@

Instance Methods

close()

Close httplib2 connections.

- delete(project, instance, database, x__xgafv=None)

+ delete(project, instance, database, location=None, x__xgafv=None)

Deletes a database from a Cloud SQL instance.

- get(project, instance, database, x__xgafv=None)

+ get(project, instance, database, location=None, x__xgafv=None)

Retrieves a resource containing information about a database inside a Cloud SQL instance.

- insert(project, instance, body=None, x__xgafv=None)

+ insert(project, instance, body=None, location=None, x__xgafv=None)

Inserts a resource containing information about a database inside a Cloud SQL instance. **Note:** You can't modify the default character set and collation.

- list(project, instance, x__xgafv=None)

+ list(project, instance, location=None, x__xgafv=None)

Lists databases in the specified Cloud SQL instance.

- patch(project, instance, database, body=None, x__xgafv=None)

+ patch(project, instance, database, body=None, location=None, x__xgafv=None)

Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.

- update(project, instance, database, body=None, x__xgafv=None)

+ update(project, instance, database, body=None, location=None, x__xgafv=None)

Updates a resource containing information about a database inside a Cloud SQL instance.

Method Details

@@ -102,13 +102,14 @@

Method Details

- delete(project, instance, database, x__xgafv=None) + delete(project, instance, database, location=None, x__xgafv=None)
Deletes a database from a Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Database instance ID. This does not include the project ID. (required)
   database: string, Name of the database to be deleted in the instance. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -267,13 +268,14 @@ 

Method Details

- get(project, instance, database, x__xgafv=None) + get(project, instance, database, location=None, x__xgafv=None)
Retrieves a resource containing information about a database inside a Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Database instance ID. This does not include the project ID. (required)
   database: string, Name of the database in the instance. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -299,7 +301,7 @@ 

Method Details

- insert(project, instance, body=None, x__xgafv=None) + insert(project, instance, body=None, location=None, x__xgafv=None)
Inserts a resource containing information about a database inside a Cloud SQL instance. **Note:** You can't modify the default character set and collation.
 
 Args:
@@ -323,6 +325,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -481,12 +484,13 @@

Method Details

- list(project, instance, x__xgafv=None) + list(project, instance, location=None, x__xgafv=None)
Lists databases in the specified Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -517,7 +521,7 @@ 

Method Details

- patch(project, instance, database, body=None, x__xgafv=None) + patch(project, instance, database, body=None, location=None, x__xgafv=None)
Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics.
 
 Args:
@@ -542,6 +546,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -700,7 +705,7 @@

Method Details

- update(project, instance, database, body=None, x__xgafv=None) + update(project, instance, database, body=None, location=None, x__xgafv=None)
Updates a resource containing information about a database inside a Cloud SQL instance.
 
 Args:
@@ -725,6 +730,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/sqladmin_v1beta4.html b/docs/dyn/sqladmin_v1beta4.html index 6840fdda2a..30e545ac58 100644 --- a/docs/dyn/sqladmin_v1beta4.html +++ b/docs/dyn/sqladmin_v1beta4.html @@ -84,6 +84,11 @@

Instance Methods

Returns the backups Resource.

+

+ blueGreenDeployments() +

+

Returns the blueGreenDeployments Resource.

+

connect()

diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index a233a9e604..a551d1585c 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -75,124 +75,125 @@

Cloud SQL Admin API . instances

Instance Methods

- ListEntraIdCertificates(project, instance, x__xgafv=None)

+ ListEntraIdCertificates(project, instance, location=None, x__xgafv=None)

Lists all versions of EntraID certificates for the specified instance. There can be up to three sets of certificates listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.

- ListServerCertificates(project, instance, x__xgafv=None)

+ ListServerCertificates(project, instance, location=None, x__xgafv=None)

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.

- RotateEntraIdCertificate(project, instance, body=None, x__xgafv=None)

+ RotateEntraIdCertificate(project, instance, body=None, location=None, x__xgafv=None)

Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method.

- RotateServerCertificate(project, instance, body=None, x__xgafv=None)

+ RotateServerCertificate(project, instance, body=None, location=None, x__xgafv=None)

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.

- acquireSsrsLease(project, instance, body=None, x__xgafv=None)

+ acquireSsrsLease(project, instance, body=None, location=None, x__xgafv=None)

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

- addEntraIdCertificate(project, instance, x__xgafv=None)

+ addEntraIdCertificate(project, instance, location=None, x__xgafv=None)

Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version.

- addServerCa(project, instance, x__xgafv=None)

+ addServerCa(project, instance, location=None, x__xgafv=None)

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.

- addServerCertificate(project, instance, x__xgafv=None)

+ addServerCertificate(project, instance, location=None, x__xgafv=None)

Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead.

- clone(project, instance, body=None, x__xgafv=None)

+ clone(project, instance, body=None, location=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

close()

Close httplib2 connections.

- delete(project, instance, enableFinalBackup=None, finalBackupDescription=None, finalBackupExpiryTime=None, finalBackupTtlDays=None, x__xgafv=None)

+ delete(project, instance, enableFinalBackup=None, finalBackupDescription=None, finalBackupExpiryTime=None, finalBackupTtlDays=None, location=None, x__xgafv=None)

Deletes a Cloud SQL instance.

- demote(project, instance, body=None, x__xgafv=None)

+ demote(project, instance, body=None, location=None, x__xgafv=None)

Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.

- demoteMaster(project, instance, body=None, x__xgafv=None)

+ demoteMaster(project, instance, body=None, location=None, x__xgafv=None)

Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

- executeSql(project, instance, body=None, x__xgafv=None)

+ executeSql(project, instance, body=None, location=None, x__xgafv=None)

Execute SQL statements.

- export(project, instance, body=None, x__xgafv=None)

+ export(project, instance, body=None, location=None, x__xgafv=None)

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

- failover(project, instance, body=None, x__xgafv=None)

+ failover(project, instance, body=None, location=None, x__xgafv=None)

Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

- get(project, instance, x__xgafv=None)

+ get(project, instance, location=None, x__xgafv=None)

Retrieves a resource containing information about a Cloud SQL instance.

- import_(project, instance, body=None, x__xgafv=None)

+ import_(project, instance, body=None, location=None, x__xgafv=None)

Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

- insert(project, body=None, x__xgafv=None)

+ insert(project, body=None, location=None, x__xgafv=None)

Creates a new Cloud SQL instance.

- list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)

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

Lists instances under a given project.

- listServerCas(project, instance, x__xgafv=None)

+ listServerCas(project, instance, location=None, x__xgafv=None)

Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.

list_next(previous_request, previous_response)

Retrieves the next page of results.

- patch(project, instance, body=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)

+ patch(project, instance, body=None, location=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

pointInTimeRestore(parent, body=None, x__xgafv=None)

Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.

- preCheckMajorVersionUpgrade(project, instance, body=None, x__xgafv=None)

+ preCheckMajorVersionUpgrade(project, instance, body=None, location=None, x__xgafv=None)

Execute MVU Pre-checks

- promoteReplica(project, instance, failover=None, x__xgafv=None)

+ promoteReplica(project, instance, failover=None, location=None, x__xgafv=None)

Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

- reencrypt(project, instance, body=None, x__xgafv=None)

+ reencrypt(project, instance, body=None, location=None, x__xgafv=None)

Reencrypt CMEK instance with latest key version.

- releaseSsrsLease(project, instance, x__xgafv=None)

+ releaseSsrsLease(project, instance, location=None, x__xgafv=None)

Release a lease for the setup of SQL Server Reporting Services (SSRS).

- resetSslConfig(project, instance, mode=None, x__xgafv=None)

+ resetSslConfig(project, instance, location=None, mode=None, x__xgafv=None)

Deletes all client certificates and generates a new server SSL certificate for the instance.

- restart(project, instance, x__xgafv=None)

+ restart(project, instance, location=None, x__xgafv=None)

Restarts a Cloud SQL instance.

- restoreBackup(project, instance, body=None, x__xgafv=None)

+ restoreBackup(project, instance, body=None, location=None, x__xgafv=None)

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

- rotateServerCa(project, instance, body=None, x__xgafv=None)

+ rotateServerCa(project, instance, body=None, location=None, x__xgafv=None)

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.

- startReplica(project, instance, x__xgafv=None)

+ startReplica(project, instance, location=None, x__xgafv=None)

Starts the replication in the read replica instance.

- stopReplica(project, instance, x__xgafv=None)

+ stopReplica(project, instance, location=None, x__xgafv=None)

Stops the replication in the read replica instance.

- switchover(project, instance, dbTimeout=None, x__xgafv=None)

+ switchover(project, instance, dbTimeout=None, location=None, x__xgafv=None)

Switches over from the primary instance to the DR replica instance.

- truncateLog(project, instance, body=None, x__xgafv=None)

+ truncateLog(project, instance, body=None, location=None, x__xgafv=None)

Truncate MySQL general and slow query log tables MySQL only.

- update(project, instance, body=None, x__xgafv=None)

+ update(project, instance, body=None, location=None, x__xgafv=None)

Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Method Details

- ListEntraIdCertificates(project, instance, x__xgafv=None) + ListEntraIdCertificates(project, instance, location=None, x__xgafv=None)
Lists all versions of EntraID certificates for the specified instance. There can be up to three sets of certificates listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
   instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -221,12 +222,13 @@ 

Method Details

- ListServerCertificates(project, instance, x__xgafv=None) + ListServerCertificates(project, instance, location=None, x__xgafv=None)
Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
   instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -268,7 +270,7 @@ 

Method Details

- RotateEntraIdCertificate(project, instance, body=None, x__xgafv=None) + RotateEntraIdCertificate(project, instance, body=None, location=None, x__xgafv=None)
Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method.
 
 Args:
@@ -284,6 +286,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -442,7 +445,7 @@

Method Details

- RotateServerCertificate(project, instance, body=None, x__xgafv=None) + RotateServerCertificate(project, instance, body=None, location=None, x__xgafv=None)
Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.
 
 Args:
@@ -458,6 +461,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -616,7 +620,7 @@

Method Details

- acquireSsrsLease(project, instance, body=None, x__xgafv=None) + acquireSsrsLease(project, instance, body=None, location=None, x__xgafv=None)
Acquire a lease for the setup of SQL Server Reporting Services (SSRS).
 
 Args:
@@ -634,6 +638,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -648,12 +653,13 @@

Method Details

- addEntraIdCertificate(project, instance, x__xgafv=None) + addEntraIdCertificate(project, instance, location=None, x__xgafv=None)
Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
   instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -812,12 +818,13 @@ 

Method Details

- addServerCa(project, instance, x__xgafv=None) + addServerCa(project, instance, location=None, x__xgafv=None)
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -976,12 +983,13 @@ 

Method Details

- addServerCertificate(project, instance, x__xgafv=None) + addServerCertificate(project, instance, location=None, x__xgafv=None)
Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead.
 
 Args:
   project: string, Required. Project ID of the project that contains the instance. (required)
   instance: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1140,7 +1148,7 @@ 

Method Details

- clone(project, instance, body=None, x__xgafv=None) + clone(project, instance, body=None, location=None, x__xgafv=None)
Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
 
 Args:
@@ -1172,6 +1180,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1335,7 +1344,7 @@

Method Details

- delete(project, instance, enableFinalBackup=None, finalBackupDescription=None, finalBackupExpiryTime=None, finalBackupTtlDays=None, x__xgafv=None) + delete(project, instance, enableFinalBackup=None, finalBackupDescription=None, finalBackupExpiryTime=None, finalBackupTtlDays=None, location=None, x__xgafv=None)
Deletes a Cloud SQL instance.
 
 Args:
@@ -1345,6 +1354,7 @@ 

Method Details

finalBackupDescription: string, Optional. The description of the final backup. finalBackupExpiryTime: string, Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. finalBackupTtlDays: string, Optional. Retention period of the final backup. + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1503,7 +1513,7 @@

Method Details

- demote(project, instance, body=None, x__xgafv=None) + demote(project, instance, body=None, location=None, x__xgafv=None)
Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.
 
 Args:
@@ -1519,6 +1529,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1677,7 +1688,7 @@

Method Details

- demoteMaster(project, instance, body=None, x__xgafv=None) + demoteMaster(project, instance, body=None, location=None, x__xgafv=None)
Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
 
 Args:
@@ -1706,6 +1717,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1864,7 +1876,7 @@

Method Details

- executeSql(project, instance, body=None, x__xgafv=None) + executeSql(project, instance, body=None, location=None, x__xgafv=None)
Execute SQL statements.
 
 Args:
@@ -1884,6 +1896,7 @@ 

Method Details

"user": "A String", # Optional. The name of an existing database user to connect to the database. When `auto_iam_authn` is set to true, this field is ignored and the API caller's IAM user is used. } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1946,7 +1959,7 @@

Method Details

- export(project, instance, body=None, x__xgafv=None) + export(project, instance, body=None, location=None, x__xgafv=None)
Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
 
 Args:
@@ -2004,6 +2017,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -2162,7 +2176,7 @@

Method Details

- failover(project, instance, body=None, x__xgafv=None) + failover(project, instance, body=None, location=None, x__xgafv=None)
Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.
 
 Args:
@@ -2178,6 +2192,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -2336,12 +2351,13 @@

Method Details

- get(project, instance, x__xgafv=None) + get(project, instance, location=None, x__xgafv=None)
Retrieves a resource containing information about a Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Database instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2361,7 +2377,26 @@ 

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -2637,7 +2672,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -2675,7 +2710,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -2756,7 +2791,7 @@

Method Details

- import_(project, instance, body=None, x__xgafv=None) + import_(project, instance, body=None, location=None, x__xgafv=None)
Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.
 
 Args:
@@ -2813,6 +2848,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -2971,7 +3007,7 @@

Method Details

- insert(project, body=None, x__xgafv=None) + insert(project, body=None, location=None, x__xgafv=None)
Creates a new Cloud SQL instance.
 
 Args:
@@ -2990,7 +3026,26 @@ 

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -3266,7 +3321,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -3304,7 +3359,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -3383,6 +3438,7 @@

Method Details

"writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -3541,12 +3597,13 @@

Method Details

- list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None) + list(project, filter=None, location=None, maxResults=None, pageToken=None, x__xgafv=None)
Lists instances under a given project.
 
 Args:
   project: string, Project ID of the project for which to list Cloud SQL instances. (required)
   filter: string, A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
+  location: string, Optional. Region of the Cloud SQL instance.
   maxResults: integer, The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
   pageToken: string, A previously-returned page token representing part of the larger set of results to view.
   x__xgafv: string, V1 error format.
@@ -3570,7 +3627,26 @@ 

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -3846,7 +3922,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -3884,7 +3960,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -3976,12 +4052,13 @@

Method Details

- listServerCas(project, instance, x__xgafv=None) + listServerCas(project, instance, location=None, x__xgafv=None)
Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4024,7 +4101,7 @@ 

Method Details

- patch(project, instance, body=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None) + patch(project, instance, body=None, location=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)
Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
 
 Args:
@@ -4044,7 +4121,26 @@ 

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -4320,7 +4416,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -4358,7 +4454,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -4437,6 +4533,7 @@

Method Details

"writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. } + location: string, Optional. Region of the Cloud SQL instance. reconcilePscNetworking: boolean, Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking. reconcilePscNetworkingForce: boolean, Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking. x__xgafv: string, V1 error format. @@ -4628,7 +4725,26 @@

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -4904,7 +5020,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -4942,7 +5058,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -5180,7 +5296,7 @@

Method Details

- preCheckMajorVersionUpgrade(project, instance, body=None, x__xgafv=None) + preCheckMajorVersionUpgrade(project, instance, body=None, location=None, x__xgafv=None)
Execute MVU Pre-checks
 
 Args:
@@ -5205,6 +5321,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -5363,13 +5480,14 @@

Method Details

- promoteReplica(project, instance, failover=None, x__xgafv=None) + promoteReplica(project, instance, failover=None, location=None, x__xgafv=None)
Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
 
 Args:
   project: string, ID of the project that contains the read replica. (required)
   instance: string, Cloud SQL read replica instance name. (required)
   failover: boolean, Set to true to invoke a replica failover to the DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance.
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -5528,7 +5646,7 @@ 

Method Details

- reencrypt(project, instance, body=None, x__xgafv=None) + reencrypt(project, instance, body=None, location=None, x__xgafv=None)
Reencrypt CMEK instance with latest key version.
 
 Args:
@@ -5544,6 +5662,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -5702,12 +5821,13 @@

Method Details

- releaseSsrsLease(project, instance, x__xgafv=None) + releaseSsrsLease(project, instance, location=None, x__xgafv=None)
Release a lease for the setup of SQL Server Reporting Services (SSRS).
 
 Args:
   project: string, Required. The ID of the project that contains the instance (Example: project-id). (required)
   instance: string, Required. The Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id). (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -5722,12 +5842,13 @@ 

Method Details

- resetSslConfig(project, instance, mode=None, x__xgafv=None) + resetSslConfig(project, instance, location=None, mode=None, x__xgafv=None)
Deletes all client certificates and generates a new server SSL certificate for the instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   mode: string, Optional. Reset SSL mode to use.
     Allowed values
       RESET_SSL_MODE_UNSPECIFIED - Reset SSL mode is not specified.
@@ -5891,12 +6012,13 @@ 

Method Details

- restart(project, instance, x__xgafv=None) + restart(project, instance, location=None, x__xgafv=None)
Restarts a Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance to be restarted. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -6055,7 +6177,7 @@ 

Method Details

- restoreBackup(project, instance, body=None, x__xgafv=None) + restoreBackup(project, instance, body=None, location=None, x__xgafv=None)
Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.
 
 Args:
@@ -6067,6 +6189,7 @@ 

Method Details

{ # Database instance restore backup request. "backup": "A String", # The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. "backupdrBackup": "A String", # The name of the backup that's used to restore a Cloud SQL instance: Format: "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. + "ignoreMaintenanceVersion": True or False, # Optional. If true, the restore operation proceeds even if the target instance's maintenance version is older than the source instance's maintenance version. "restoreBackupContext": { # Database instance restore from backup context. Backup context contains source instance id and project id. # Parameters required to perform the restore backup operation. "backupRunId": "A String", # The ID of the backup run to restore from. "instanceId": "A String", # The ID of the instance that the backup was taken from. @@ -6087,7 +6210,26 @@

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -6363,7 +6505,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -6401,7 +6543,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -6481,6 +6623,7 @@

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -6639,7 +6782,7 @@

Method Details

- rotateServerCa(project, instance, body=None, x__xgafv=None) + rotateServerCa(project, instance, body=None, location=None, x__xgafv=None)
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.
 
 Args:
@@ -6655,6 +6798,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -6813,12 +6957,13 @@

Method Details

- startReplica(project, instance, x__xgafv=None) + startReplica(project, instance, location=None, x__xgafv=None)
Starts the replication in the read replica instance.
 
 Args:
   project: string, ID of the project that contains the read replica. (required)
   instance: string, Cloud SQL read replica instance name. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -6977,12 +7122,13 @@ 

Method Details

- stopReplica(project, instance, x__xgafv=None) + stopReplica(project, instance, location=None, x__xgafv=None)
Stops the replication in the read replica instance.
 
 Args:
   project: string, ID of the project that contains the read replica. (required)
   instance: string, Cloud SQL read replica instance name. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -7141,13 +7287,14 @@ 

Method Details

- switchover(project, instance, dbTimeout=None, x__xgafv=None) + switchover(project, instance, dbTimeout=None, location=None, x__xgafv=None)
Switches over from the primary instance to the DR replica instance.
 
 Args:
   project: string, ID of the project that contains the replica. (required)
   instance: string, Cloud SQL read replica instance name. (required)
   dbTimeout: string, Optional. (MySQL and PostgreSQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -7306,7 +7453,7 @@ 

Method Details

- truncateLog(project, instance, body=None, x__xgafv=None) + truncateLog(project, instance, body=None, location=None, x__xgafv=None)
Truncate MySQL general and slow query log tables MySQL only.
 
 Args:
@@ -7322,6 +7469,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -7480,7 +7628,7 @@

Method Details

- update(project, instance, body=None, x__xgafv=None) + update(project, instance, body=None, location=None, x__xgafv=None)
Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.
 
 Args:
@@ -7500,7 +7648,26 @@ 

Method Details

"databaseCenterIntegrationEnabled": True or False, # Optional. If true, instance metadata is sent to the Database Center. If false, instance metadata is not sent to the Database Center. "databaseInstalledVersion": "A String", # Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. "databaseVersion": "A String", # The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. + "deploymentInfo": { # Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment. # Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup. + "deploymentId": "A String", # Output only. The resource ID of the blue-green deployment. + "source": { # The source instance for the Blue-Green deployment. # Output only. The source instance for the Blue-Green deployment. + "targetId": { # Reference to another Cloud SQL instance. # Output only. The target instance paired with this source instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + "state": "A String", # Output only. The current state of blue-green-deployment for UI tags + "target": { # The target instance for the Blue-Green deployment. # Output only. The target instance for the Blue-Green deployment. + "sourceId": { # Reference to another Cloud SQL instance. # Output only. The source instance paired with this target instance in a blue-green deployment. + "name": "A String", # The name of the Cloud SQL instance being referenced. This does not include the project ID. + "project": "A String", # The project ID of the Cloud SQL instance being referenced. The default is the same project ID as the instance references it. + "region": "A String", # The region of the Cloud SQL instance being referenced. + }, + }, + }, "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. + "confidentialMode": True or False, # Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently. "kind": "A String", # This is always `sql#diskEncryptionConfiguration`. "kmsKeyName": "A String", # Resource name of KMS key for disk encryption }, @@ -7776,7 +7943,7 @@

Method Details

"allowedConsumerProjects": [ # Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). "A String", ], - "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID + "networkAttachmentUri": "A String", # Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID "pscAutoConnectionPolicyEnabled": True or False, # Optional. Whether to set up the PSC service connection policy automatically. "pscAutoConnections": [ # Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance. { # Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance. @@ -7814,7 +7981,7 @@

Method Details

"kind": "A String", # This is always `sql#maintenanceWindow`. "updateTrack": "A String", # Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). }, - "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance. + "passwordValidationPolicy": { # Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. # The local user password validation policy of the instance for PostgreSQL and MySQL. "complexity": "A String", # The complexity of the password. "disallowCompromisedCredentials": True or False, # This field is deprecated and will be removed in a future version of the API. "disallowUsernameSubstring": True or False, # Disallow username as a part of the password. @@ -7893,6 +8060,7 @@

Method Details

"writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/sqladmin_v1beta4.projects.instances.html b/docs/dyn/sqladmin_v1beta4.projects.instances.html index 27908dfe20..67a3560855 100644 --- a/docs/dyn/sqladmin_v1beta4.projects.instances.html +++ b/docs/dyn/sqladmin_v1beta4.projects.instances.html @@ -78,16 +78,16 @@

Instance Methods

close()

Close httplib2 connections.

- getDiskShrinkConfig(project, instance, x__xgafv=None)

+ getDiskShrinkConfig(project, instance, location=None, x__xgafv=None)

Get Disk Shrink Config for a given instance.

- getLatestRecoveryTime(project, instance, sourceInstanceDeletionTime=None, x__xgafv=None)

+ getLatestRecoveryTime(project, instance, location=None, sourceInstanceDeletionTime=None, x__xgafv=None)

Get Latest Recovery Time for a given instance.

- performDiskShrink(project, instance, body=None, x__xgafv=None)

+ performDiskShrink(project, instance, body=None, location=None, x__xgafv=None)

Perform Disk Shrink on primary instance.

- rescheduleMaintenance(project, instance, body=None, x__xgafv=None)

+ rescheduleMaintenance(project, instance, body=None, location=None, x__xgafv=None)

Reschedules the maintenance on the given instance.

resetReplicaSize(project, instance, body=None, x__xgafv=None)

@@ -105,12 +105,13 @@

Method Details

- getDiskShrinkConfig(project, instance, x__xgafv=None) + getDiskShrinkConfig(project, instance, location=None, x__xgafv=None)
Get Disk Shrink Config for a given instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -127,12 +128,13 @@ 

Method Details

- getLatestRecoveryTime(project, instance, sourceInstanceDeletionTime=None, x__xgafv=None) + getLatestRecoveryTime(project, instance, location=None, sourceInstanceDeletionTime=None, x__xgafv=None)
Get Latest Recovery Time for a given instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   sourceInstanceDeletionTime: string, The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -150,7 +152,7 @@ 

Method Details

- performDiskShrink(project, instance, body=None, x__xgafv=None) + performDiskShrink(project, instance, body=None, location=None, x__xgafv=None)
Perform Disk Shrink on primary instance.
 
 Args:
@@ -163,6 +165,7 @@ 

Method Details

"targetSizeGb": "A String", # The target disk shrink size in GigaBytes. } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -321,7 +324,7 @@

Method Details

- rescheduleMaintenance(project, instance, body=None, x__xgafv=None) + rescheduleMaintenance(project, instance, body=None, location=None, x__xgafv=None)
Reschedules the maintenance on the given instance.
 
 Args:
@@ -337,6 +340,7 @@ 

Method Details

}, } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -505,6 +509,7 @@

Method Details

The object takes the form of: { # Instance reset replica size request. + "location": "A String", # Optional. Region of the Cloud SQL instance. } x__xgafv: string, V1 error format. @@ -675,6 +680,7 @@

Method Details

The object takes the form of: { + "location": "A String", # Optional. Region of the Cloud SQL instance. "migrationType": "A String", # Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL. "mysqlSyncConfig": { # MySQL-specific external server sync settings. # MySQL-specific settings for start external sync. "initialSyncFlags": [ # Flags to use for the initial dump. @@ -858,6 +864,7 @@

Method Details

The object takes the form of: { + "location": "A String", # Optional. Region of the Cloud SQL instance. "migrationType": "A String", # Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL. "mysqlSyncConfig": { # MySQL-specific external server sync settings. # Optional. MySQL-specific settings for start external sync. "initialSyncFlags": [ # Flags to use for the initial dump. diff --git a/docs/dyn/sqladmin_v1beta4.sslCerts.html b/docs/dyn/sqladmin_v1beta4.sslCerts.html index 9062bb4cc3..b34599496b 100644 --- a/docs/dyn/sqladmin_v1beta4.sslCerts.html +++ b/docs/dyn/sqladmin_v1beta4.sslCerts.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- createEphemeral(project, instance, body=None, x__xgafv=None)

+ createEphemeral(project, instance, body=None, location=None, x__xgafv=None)

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

delete(project, instance, sha1Fingerprint, x__xgafv=None)

@@ -99,7 +99,7 @@

Method Details

- createEphemeral(project, instance, body=None, x__xgafv=None) + createEphemeral(project, instance, body=None, location=None, x__xgafv=None)
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
 
 Args:
@@ -113,6 +113,7 @@ 

Method Details

"public_key": "A String", # PEM encoded public key to include in the signed certificate. } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html index e866fed400..48130cd572 100644 --- a/docs/dyn/sqladmin_v1beta4.users.html +++ b/docs/dyn/sqladmin_v1beta4.users.html @@ -78,19 +78,19 @@

Instance Methods

close()

Close httplib2 connections.

- delete(project, instance, host=None, name=None, x__xgafv=None)

+ delete(project, instance, host=None, location=None, name=None, x__xgafv=None)

Deletes a user from a Cloud SQL instance.

- get(project, instance, name, host=None, x__xgafv=None)

+ get(project, instance, name, host=None, location=None, x__xgafv=None)

Retrieves a resource containing information about a user.

- insert(project, instance, body=None, x__xgafv=None)

+ insert(project, instance, body=None, location=None, x__xgafv=None)

Creates a new user in a Cloud SQL instance.

- list(project, instance, x__xgafv=None)

+ list(project, instance, location=None, x__xgafv=None)

Lists users in the specified Cloud SQL instance.

- update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, revokeExistingServerRoles=None, serverRoles=None, x__xgafv=None)

+ update(project, instance, body=None, databaseRoles=None, host=None, location=None, name=None, revokeExistingRoles=None, revokeExistingServerRoles=None, serverRoles=None, x__xgafv=None)

Updates an existing user in a Cloud SQL instance.

Method Details

@@ -99,13 +99,14 @@

Method Details

- delete(project, instance, host=None, name=None, x__xgafv=None) + delete(project, instance, host=None, location=None, name=None, x__xgafv=None)
Deletes a user from a Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Database instance ID. This does not include the project ID. (required)
   host: string, Host of the user in the instance.
+  location: string, Optional. Region of the Cloud SQL instance.
   name: string, Name of the user in the instance.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -265,7 +266,7 @@ 

Method Details

- get(project, instance, name, host=None, x__xgafv=None) + get(project, instance, name, host=None, location=None, x__xgafv=None)
Retrieves a resource containing information about a user.
 
 Args:
@@ -273,6 +274,7 @@ 

Method Details

instance: string, Database instance ID. This does not include the project ID. (required) name: string, User of the instance. (required) host: string, Host of a user of the instance. + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -309,8 +311,8 @@

Method Details

"A String", ], "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. - "disabled": True or False, # If the user has been disabled - "serverRoles": [ # The server roles for this user + "disabled": True or False, # Indicates if the user has been disabled. + "serverRoles": [ # Indicates the server roles for this user. "A String", ], }, @@ -319,7 +321,7 @@

Method Details

- insert(project, instance, body=None, x__xgafv=None) + insert(project, instance, body=None, location=None, x__xgafv=None)
Creates a new user in a Cloud SQL instance.
 
 Args:
@@ -356,14 +358,15 @@ 

Method Details

"A String", ], "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. - "disabled": True or False, # If the user has been disabled - "serverRoles": [ # The server roles for this user + "disabled": True or False, # Indicates if the user has been disabled. + "serverRoles": [ # Indicates the server roles for this user. "A String", ], }, "type": "A String", # The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. } + location: string, Optional. Region of the Cloud SQL instance. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -522,12 +525,13 @@

Method Details

- list(project, instance, x__xgafv=None) + list(project, instance, location=None, x__xgafv=None)
Lists users in the specified Cloud SQL instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Database instance ID. This does not include the project ID. (required)
+  location: string, Optional. Region of the Cloud SQL instance.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -566,8 +570,8 @@ 

Method Details

"A String", ], "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. - "disabled": True or False, # If the user has been disabled - "serverRoles": [ # The server roles for this user + "disabled": True or False, # Indicates if the user has been disabled. + "serverRoles": [ # Indicates the server roles for this user. "A String", ], }, @@ -580,7 +584,7 @@

Method Details

- update(project, instance, body=None, databaseRoles=None, host=None, name=None, revokeExistingRoles=None, revokeExistingServerRoles=None, serverRoles=None, x__xgafv=None) + update(project, instance, body=None, databaseRoles=None, host=None, location=None, name=None, revokeExistingRoles=None, revokeExistingServerRoles=None, serverRoles=None, x__xgafv=None)
Updates an existing user in a Cloud SQL instance.
 
 Args:
@@ -617,8 +621,8 @@ 

Method Details

"A String", ], "sqlserverUserDetails": { # Represents a Sql Server user on the Cloud SQL instance. - "disabled": True or False, # If the user has been disabled - "serverRoles": [ # The server roles for this user + "disabled": True or False, # Indicates if the user has been disabled. + "serverRoles": [ # Indicates the server roles for this user. "A String", ], }, @@ -627,6 +631,7 @@

Method Details

databaseRoles: string, Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. (repeated) host: string, Optional. Host of the user in the instance. + location: string, Optional. Region of the Cloud SQL instance. name: string, Name of the user in the instance. revokeExistingRoles: boolean, Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles. revokeExistingServerRoles: boolean, Optional. Specifies whether to revoke existing roles that are not present in the `server_roles` field. If `false` or unset, the server roles specified in `server_roles` are added to the user's existing server roles. diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index c15eaea061..f03456d8a8 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -664,6 +664,192 @@ } } }, +"blueGreenDeployments": { +"methods": { +"create": { +"description": "Creates a blue-green deployment under a given project and location. This deployment provisions a synchronized green environment (target instance) from a blue production environment (source instance), facilitating updates like major version upgrades on the green instance without impacting the blue instance.", +"flatPath": "sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments", +"httpMethod": "POST", +"id": "sql.blueGreenDeployments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"blueGreenDeploymentId": { +"description": "Required. The ID to use for the blue-green deployment, which will become the final component of the deployment's resource name.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource where this blue-green deployment will be created. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/{+parent}/blueGreenDeployments", +"request": { +"$ref": "BlueGreenDeployment" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, +"delete": { +"description": "Deletes a blue-green deployment, including metadata and underlying resources based on the deployment state. If issued before switchover, this deletes the green instance. If issued after switchover, this deletes the old blue instance (source instance) if the `delete_old_source` field in the request is set to true. All blue-green deployment metadata is permanently deleted. Resources deleted as a result of this operation are no longer accessible and can't be restored.", +"flatPath": "sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}", +"httpMethod": "DELETE", +"id": "sql.blueGreenDeployments.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"deleteOldSource": { +"description": "Optional. If set to true, and the switchover is complete, this deletes the old source instance along with the deployment.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the blue-green deployment to delete. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, +"get": { +"description": "Retrieves a blue-green deployment resource under a given project and location.", +"flatPath": "sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}", +"httpMethod": "GET", +"id": "sql.blueGreenDeployments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the blue-green deployment to retrieve. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Specifies whether to return the basic or detailed view of the resource in the response.", +"enum": [ +"BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED", +"BASIC", +"DETAILED" +], +"enumDescriptions": [ +"Blue-green deployment view enumeration. This allows the caller to specify what view they query. If unspecified (BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED), the behavior is the same as BASIC.", +"Includes basic metadata about the blue-green deployment. `BASIC` is the default view.", +"Includes basic metadata and configuration differences between source and target instances (`database_version`, `tier`, `edition`, `availability_type`, `data_disk_size_gb`, and `data_disk_type`)." +], +"location": "query", +"type": "string" +} +}, +"path": "sql/v1beta4/{+name}", +"response": { +"$ref": "BlueGreenDeployment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, +"list": { +"description": "Lists blue-green deployments under a given project.", +"flatPath": "sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments", +"httpMethod": "GET", +"id": "sql.blueGreenDeployments.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order the results by.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of deployments to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListBlueGreenDeployments` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/{+parent}/blueGreenDeployments", +"response": { +"$ref": "ListBlueGreenDeploymentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +}, +"switchover": { +"description": "Switches over to green instance for a blue-green deployment.", +"flatPath": "sql/v1beta4/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}:switchover", +"httpMethod": "POST", +"id": "sql.blueGreenDeployments.switchover", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the blue-green deployment to switch over. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "sql/v1beta4/{+name}:switchover", +"request": { +"$ref": "SwitchoverBlueGreenDeploymentRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/sqlservice.admin" +] +} +} +}, "connect": { "methods": { "generateEphemeralCert": { @@ -798,6 +984,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -837,6 +1028,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -869,6 +1065,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -904,6 +1105,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -943,6 +1149,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -985,6 +1196,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1065,6 +1281,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1097,6 +1318,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1129,6 +1355,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1164,6 +1395,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1199,6 +1435,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. ID of the project that contains the instance (Example: project-id).", "location": "path", @@ -1234,6 +1475,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1266,6 +1512,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1298,6 +1549,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1330,6 +1586,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the source Cloud SQL instance.", "location": "path", @@ -1387,6 +1648,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance to be deleted.", "location": "path", @@ -1419,6 +1685,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. The project ID of the project that contains the instance.", "location": "path", @@ -1454,6 +1725,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the instance.", "location": "path", @@ -1489,6 +1765,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1524,6 +1805,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance to be exported.", "location": "path", @@ -1558,6 +1844,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the read replica.", "location": "path", @@ -1593,6 +1884,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1625,6 +1921,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1652,6 +1953,11 @@ "project" ], "parameters": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project to which the newly created Cloud SQL instances should belong.", "location": "path", @@ -1685,6 +1991,11 @@ "location": "query", "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "maxResults": { "description": "The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "uint32", @@ -1728,6 +2039,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1760,6 +2076,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -1834,6 +2155,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. Project ID of the project that contains the instance.", "location": "path", @@ -1874,6 +2200,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the read replica.", "location": "path", @@ -1906,6 +2237,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the instance.", "location": "path", @@ -1941,6 +2277,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Required. The ID of the project that contains the instance (Example: project-id).", "location": "path", @@ -1973,6 +2314,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "mode": { "description": "Optional. Reset SSL mode to use.", "enum": [ @@ -2020,6 +2366,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance to be restarted.", "location": "path", @@ -2052,6 +2403,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2087,6 +2443,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2122,6 +2483,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the read replica.", "location": "path", @@ -2154,6 +2520,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the read replica.", "location": "path", @@ -2192,6 +2563,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the replica.", "location": "path", @@ -2224,6 +2600,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the Cloud SQL project.", "location": "path", @@ -2259,6 +2640,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2424,6 +2810,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2456,6 +2847,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2494,6 +2890,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -2529,6 +2930,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "ID of the project that contains the instance.", "location": "path", @@ -2675,6 +3081,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the Cloud SQL project.", "location": "path", @@ -2893,6 +3304,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "name": { "description": "Name of the user in the instance.", "location": "query", @@ -2936,6 +3352,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "name": { "description": "User of the instance.", "location": "path", @@ -2974,6 +3395,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -3009,6 +3435,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID of the project that contains the instance.", "location": "path", @@ -3052,6 +3483,11 @@ "required": true, "type": "string" }, +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"location": "query", +"type": "string" +}, "name": { "description": "Name of the user in the instance.", "location": "query", @@ -3095,7 +3531,7 @@ } } }, -"revision": "20260722", +"revision": "20260819", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -4053,6 +4489,133 @@ false }, "type": "object" }, +"BlueGreenDeployment": { +"description": "A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment setup. It orchestrates the lifecycle of creating a synchronized \"green\" environment from a \"blue\" production environment, performing updates, and managing the switchover process to minimize downtime.", +"id": "BlueGreenDeployment", +"properties": { +"createTime": { +"description": "Output only. The time when the deployment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deploymentMappings": { +"description": "Output only. A list representing the pairs of source and target instances in the deployment.", +"items": { +"$ref": "SourceTargetPairedNode" +}, +"readOnly": true, +"type": "array" +}, +"deploymentTasks": { +"$ref": "DeploymentTasks", +"description": "Output only. Combined list of tasks for all paired nodes.", +"readOnly": true +}, +"description": { +"description": "Optional. User-provided description for the deployment.", +"type": "string" +}, +"errorDetail": { +"description": "Output only. Provides an error message with details on why switchover is not possible.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Identifier. The full resource name of the deployment. Format: projects/{project}/locations/{location}/blueGreenDeployments/{deployment_id}", +"readOnly": true, +"type": "string" +}, +"pairedNodes": { +"deprecated": true, +"description": "Output only. Deprecated: Use deployment_mappings instead. Output only. A list representing the pairs of source and target instances in the deployment.", +"items": { +"$ref": "SourceTargetPairedNode" +}, +"readOnly": true, +"type": "array" +}, +"requestedConfig": { +"$ref": "RequestedConfig", +"description": "Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created." +}, +"sourceInstance": { +"description": "Required. Immutable. The instance ID of the source instance (the \"blue\" instance). The value for this field does not include the project ID, for example, `my-instance-id`. This field is immutable.", +"type": "string" +}, +"state": { +"description": "Output only. The current state of the blue-green deployment.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"SWITCHOVER_READY", +"SWITCHOVER_NOT_READY", +"SWITCHOVER_IN_PROGRESS", +"SWITCHOVER_COMPLETED", +"DELETING" +], +"enumDescriptions": [ +"The state of the deployment is unknown.", +"The deployment is being provisioned.", +"The deployment is ready for switchover.", +"The deployment is not ready for switchover.", +"The deployment is in the process of switching over.", +"The deployment has completed switchover.", +"The deployment is being deleted." +], +"readOnly": true, +"type": "string" +}, +"switchoverTargetInstance": { +"description": "Output only. Details about the primary target instance (the \"Green\" instance) that will be promoted during switchover.", +"readOnly": true, +"type": "string" +}, +"targetConfig": { +"$ref": "TargetConfig", +"deprecated": true, +"description": "Optional. Immutable. Deprecated: Use requested_config instead. The configuration intended for the target instance(s) when the deployment was created. This field is immutable." +} +}, +"type": "object" +}, +"BlueGreenDeploymentInfo": { +"description": "Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment.", +"id": "BlueGreenDeploymentInfo", +"properties": { +"deploymentId": { +"description": "Output only. The resource ID of the blue-green deployment.", +"readOnly": true, +"type": "string" +}, +"source": { +"$ref": "SourceRole", +"description": "Output only. The source instance for the Blue-Green deployment.", +"readOnly": true +}, +"state": { +"description": "Output only. The current state of blue-green-deployment for UI tags", +"enum": [ +"STATE_UNSPECIFIED", +"PRE_SWITCHOVER", +"POST_SWITCHOVER" +], +"enumDescriptions": [ +"The state of the deployment is unknown.", +"The deployment is pre-switchover.", +"The deployment is post-switchover." +], +"readOnly": true, +"type": "string" +}, +"target": { +"$ref": "TargetRole", +"description": "Output only. The target instance for the Blue-Green deployment.", +"readOnly": true +} +}, +"type": "object" +}, "CloneContext": { "description": "Database instance clone context.", "id": "CloneContext", @@ -4129,6 +4692,28 @@ false }, "type": "object" }, +"ConfigDiff": { +"description": "Represents a specific configuration difference between Blue and Green instances.", +"id": "ConfigDiff", +"properties": { +"field": { +"description": "Output only. The name of the field that differs, fully-qualified. Example: settings.tier", +"readOnly": true, +"type": "string" +}, +"sourceValue": { +"description": "Output only. The value on the source instance.", +"readOnly": true, +"type": "string" +}, +"targetValue": { +"description": "Output only. The value on the target instance.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ConnectPoolNodeConfig": { "description": "Details of a single read pool node of a read pool.", "id": "ConnectPoolNodeConfig", @@ -4805,6 +5390,11 @@ false ], "type": "string" }, +"deploymentInfo": { +"$ref": "BlueGreenDeploymentInfo", +"description": "Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup.", +"readOnly": true +}, "diskEncryptionConfiguration": { "$ref": "DiskEncryptionConfiguration", "description": "Disk encryption configuration specific to an instance." @@ -4863,14 +5453,16 @@ false "CLOUD_SQL_INSTANCE", "ON_PREMISES_INSTANCE", "READ_REPLICA_INSTANCE", -"READ_POOL_INSTANCE" +"READ_POOL_INSTANCE", +"GREEN_INSTANCE" ], "enumDescriptions": [ "This is an unknown Cloud SQL instance type.", "A regular Cloud SQL instance that is not replicating from a primary instance.", "An instance running on the customer's premises that is not managed by Cloud SQL.", "A Cloud SQL instance acting as a read-replica.", -"A Cloud SQL read pool." +"A Cloud SQL read pool.", +"A Cloud SQL instance acting as a Blue-Green deployment target primary. (MySQL only)" ], "type": "string" }, @@ -5226,10 +5818,93 @@ false }, "type": "object" }, +"DeploymentTask": { +"description": "Represents a task executed as part of the deployment on a target instance.", +"id": "DeploymentTask", +"properties": { +"endTime": { +"description": "Output only. Task end time (if completed).", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"errorMessage": { +"description": "Output only. Optional Error details if the task state is FAILED.", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. Task start time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The current state of the task.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The state of the task is unknown.", +"The task is pending.", +"The task is running.", +"The task has succeeded.", +"The task has failed." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "Output only. The type of the task.", +"enum": [ +"TYPE_UNSPECIFIED", +"PROVISION", +"UPGRADE", +"SWITCHOVER", +"DELETE", +"POST_SWITCHOVER_OPERATIONS" +], +"enumDescriptions": [ +"The default value. This value is used if the type is omitted.", +"Creating target instance.", +"e.g., Major Version Upgrade on Target.", +"Promoting Target, Demoting Source for this pair.", +"The task is to delete deployment.", +"Post-switchover operations, including cleaning up resources of the old instance, taking final backups, and updating metadata." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DeploymentTasks": { +"description": "Combined list of tasks for all paired nodes in the deployment.", +"id": "DeploymentTasks", +"properties": { +"task": { +"description": "Output only. Tasks performed or being performed on the paired nodes of the deployment at a consolidated level.", +"items": { +"$ref": "DeploymentTask" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "DiskEncryptionConfiguration": { "description": "Disk encryption configuration for an instance.", "id": "DiskEncryptionConfiguration", "properties": { +"confidentialMode": { +"description": "Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently.", +"type": "boolean" +}, "kind": { "description": "This is always `sql#diskEncryptionConfiguration`.", "type": "string" @@ -6427,6 +7102,10 @@ false "description": "The name of the backup that's used to restore a Cloud SQL instance: Format: \"projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}\". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.", "type": "string" }, +"ignoreMaintenanceVersion": { +"description": "Optional. If true, the restore operation proceeds even if the target instance's maintenance version is older than the source instance's maintenance version.", +"type": "boolean" +}, "restoreBackupContext": { "$ref": "RestoreBackupContext", "description": "Parameters required to perform the restore backup operation." @@ -6660,6 +7339,24 @@ false }, "type": "object" }, +"ListBlueGreenDeploymentsResponse": { +"description": "The response message for listing blue-green deployment resources.", +"id": "ListBlueGreenDeploymentsResponse", +"properties": { +"blueGreenDeployments": { +"description": "The list of blue-green deployment resources.", +"items": { +"$ref": "BlueGreenDeployment" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results, or empty if there are no more results.", +"type": "string" +} +}, +"type": "object" +}, "LocationPreference": { "description": "Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.", "id": "LocationPreference", @@ -6815,6 +7512,36 @@ false }, "type": "object" }, +"NodeInfo": { +"description": "Details about an instance within the deployment.", +"id": "NodeInfo", +"properties": { +"connection": { +"description": "Output only. The instance connection name.", +"readOnly": true, +"type": "string" +}, +"dns": { +"description": "Output only. The unique DNS name for this instance.", +"readOnly": true, +"type": "string" +}, +"instance": { +"description": "Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}", +"readOnly": true, +"type": "string" +}, +"ipMappings": { +"description": "Output only. The list of IP addresses for this instance.", +"items": { +"$ref": "IpMapping" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "OnPremisesConfiguration": { "description": "On-premises instance configuration.", "id": "OnPremisesConfiguration", @@ -6988,6 +7715,9 @@ false "REPAIR_READ_POOL", "CREATE_READ_POOL", "PRE_CHECK_MAJOR_VERSION_UPGRADE", +"CREATE_BLUE_GREEN_DEPLOYMENT", +"SWITCHOVER_BLUE_GREEN_DEPLOYMENT", +"DELETE_BLUE_GREEN_DEPLOYMENT", "SETUP_MIGRATION", "AGENT_SEND_MESSAGE" ], @@ -7046,6 +7776,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -7102,6 +7835,9 @@ false "Repairs entire read pool or specified read pool nodes in the read pool.", "Creates a Cloud SQL read pool instance.", "Pre-checks for major version upgrade.", +"Creates a new Blue-Green deployment.", +"Switches over a Blue-Green deployment.", +"Deletes a Blue-Green deployment.", "This operation type represents individual steps in a multi-step setup migration workflow: including configuration, replication, switchover/back, and data reseeding, as defined by operation's intent.", "Sends a message to a Cloud SQL agent." ], @@ -7877,7 +8613,7 @@ false "type": "array" }, "networkAttachmentUri": { -"description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID", +"description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID", "type": "string" }, "pscAutoConnectionPolicyEnabled": { @@ -8025,6 +8761,17 @@ false }, "type": "object" }, +"RequestedConfig": { +"description": "Configuration specified by the user at creation time for the target (Green) instance.", +"id": "RequestedConfig", +"properties": { +"databaseVersion": { +"description": "Optional. The target database major version for the upgrade.", +"type": "string" +} +}, +"type": "object" +}, "Reschedule": { "id": "Reschedule", "properties": { @@ -8375,7 +9122,7 @@ false }, "passwordValidationPolicy": { "$ref": "PasswordValidationPolicy", -"description": "The local user password validation policy of the instance." +"description": "The local user password validation policy of the instance for PostgreSQL and MySQL." }, "performanceCaptureConfig": { "$ref": "PerformanceCaptureConfig", @@ -8459,6 +9206,96 @@ false }, "type": "object" }, +"SourceRole": { +"description": "The source instance for the Blue-Green deployment.", +"id": "SourceRole", +"properties": { +"targetId": { +"$ref": "InstanceReference", +"description": "Output only. The target instance paired with this source instance in a blue-green deployment.", +"readOnly": true +} +}, +"type": "object" +}, +"SourceTargetPairedNode": { +"description": "Represents a pairing of a source instance node and a target instance node.", +"id": "SourceTargetPairedNode", +"properties": { +"currentlyServingTraffic": { +"deprecated": true, +"description": "Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in the pair is currently live. Used for internal implementation and deprecated for external use.", +"enum": [ +"CURRENTLY_SERVING_TRAFFIC_UNSPECIFIED", +"SOURCE", +"TARGET" +], +"enumDescriptions": [ +"The instance serving traffic is unknown.", +"The source instance is serving traffic.", +"The target instance is serving traffic." +], +"readOnly": true, +"type": "string" +}, +"diffs": { +"description": "Output only. Describes the list of differences for this pair.", +"items": { +"$ref": "ConfigDiff" +}, +"readOnly": true, +"type": "array" +}, +"source": { +"$ref": "NodeInfo", +"description": "Output only. Resource name of the source instance in this pair.", +"readOnly": true +}, +"state": { +"description": "Output only. The current state of this specific source-target pair.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"PROVISIONED", +"UPGRADING", +"UPGRADED", +"UPGRADE_FAILED", +"SWITCHOVER_IN_PROGRESS", +"SWITCHOVER_FAILED", +"SWITCHOVER_SUCCEEDED", +"DELETING" +], +"enumDescriptions": [ +"The state of the paired node is unknown.", +"The paired node is being provisioned.", +"The paired node is provisioned.", +"The paired node is upgrading.", +"The paired node is upgraded.", +"Upgrade failed on the paired node.", +"Switchover is in progress.", +"Switchover failed on the paired node.", +"Switchover completed successfully.", +"The paired node is being deleted." +], +"readOnly": true, +"type": "string" +}, +"target": { +"$ref": "NodeInfo", +"description": "Output only. Details of the corresponding target instance in this pair.", +"readOnly": true +}, +"tasks": { +"description": "Output only. Tasks performed or being performed on the target instance of this pair.", +"items": { +"$ref": "DeploymentTask" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "SqlActiveDirectoryConfig": { "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.", "id": "SqlActiveDirectoryConfig", @@ -8584,7 +9421,9 @@ false "SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS", "PROMPT_DELETE_EXISTING", "WILL_DELETE_EXISTING", -"PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE" +"PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE", +"WRITABLE_DESTINATION_REPLICA_RECREATION_DOWNTIME", +"WRITABLE_DESTINATION_STORAGE_AUTO_INCREASE_DISABLED" ], "enumDescriptions": [ "", @@ -8645,7 +9484,9 @@ false "Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.", "The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.", "The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.", -"The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL." +"The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL.", +"Read replicas of the Writable Destination instance will be recreated after external synchronization is complete, causing downtime on read replicas.", +"A warning that disk storage auto increase is disabled on the destination instance for a Writable Destination migration." ], "type": "string" } @@ -8758,12 +9599,21 @@ false "SqlInstancesResetReplicaSizeRequest": { "description": "Instance reset replica size request.", "id": "SqlInstancesResetReplicaSizeRequest", -"properties": {}, +"properties": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"type": "string" +} +}, "type": "object" }, "SqlInstancesStartExternalSyncRequest": { "id": "SqlInstancesStartExternalSyncRequest", "properties": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"type": "string" +}, "migrationType": { "description": "Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.", "enum": [ @@ -8826,6 +9676,10 @@ false "SqlInstancesVerifyExternalSyncSettingsRequest": { "id": "SqlInstancesVerifyExternalSyncSettingsRequest", "properties": { +"location": { +"description": "Optional. Region of the Cloud SQL instance.", +"type": "string" +}, "migrationType": { "description": "Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.", "enum": [ @@ -9034,11 +9888,11 @@ false "id": "SqlServerUserDetails", "properties": { "disabled": { -"description": "If the user has been disabled", +"description": "Indicates if the user has been disabled.", "type": "boolean" }, "serverRoles": { -"description": "The server roles for this user", +"description": "Indicates the server roles for this user.", "items": { "type": "string" }, @@ -9226,6 +10080,12 @@ false }, "type": "object" }, +"SwitchoverBlueGreenDeploymentRequest": { +"description": "Request message for switching over a `BlueGreenDeployment` resource.", +"id": "SwitchoverBlueGreenDeploymentRequest", +"properties": {}, +"type": "object" +}, "SyncFlags": { "description": "Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.", "id": "SyncFlags", @@ -9241,6 +10101,18 @@ false }, "type": "object" }, +"TargetConfig": { +"deprecated": true, +"description": "Deprecated: Use RequestedConfig instead. Configuration specified by the user at creation time for the target (Green) instance.", +"id": "TargetConfig", +"properties": { +"databaseVersion": { +"description": "Optional. The target database major version for the upgrade.", +"type": "string" +} +}, +"type": "object" +}, "TargetMetric": { "description": "Target metric for read pool auto scaling.", "id": "TargetMetric", @@ -9257,6 +10129,18 @@ false }, "type": "object" }, +"TargetRole": { +"description": "The target instance for the Blue-Green deployment.", +"id": "TargetRole", +"properties": { +"sourceId": { +"$ref": "InstanceReference", +"description": "Output only. The source instance paired with this target instance in a blue-green deployment.", +"readOnly": true +} +}, +"type": "object" +}, "Tier": { "description": "A Google Cloud SQL service tier resource.", "id": "Tier", From ef868d7a0f98b6612aac57b447771b56aaa74480 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:18 +0000 Subject: [PATCH 35/40] feat(threatintelligence): update the api #### threatintelligence:v1beta The following keys were added: - schemas.CustomThreatScenarioConfig.properties.legacyMonitorMetadata.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.aggregationEnabled.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.aggregationSimilarity.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.conditionVersion.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.creatorUserId.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.disabledCode.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.disabledReason.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.displayName.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.emailNotificationEnabled (Total Keys: 2) - schemas.LegacyMetadata.properties.emailNotificationImmediate (Total Keys: 2) - schemas.LegacyMetadata.properties.legacyMonitorId.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.staleTime.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.templateId.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.tenantId.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.updaterUserId.readOnly (Total Keys: 1) - schemas.LegacyMetadata.properties.version.readOnly (Total Keys: 1) --- ...igence_v1beta.projects.configurations.html | 102 +++++++++--------- ...eta.projects.configurations.revisions.html | 34 +++--- .../documents/threatintelligence.v1beta.json | 55 ++++++---- 3 files changed, 105 insertions(+), 86 deletions(-) diff --git a/docs/dyn/threatintelligence_v1beta.projects.configurations.html b/docs/dyn/threatintelligence_v1beta.projects.configurations.html index a8d6d5b599..36214b413a 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.configurations.html +++ b/docs/dyn/threatintelligence_v1beta.projects.configurations.html @@ -131,23 +131,23 @@

Method Details

"query": "A String", # Required. The query string. "queryType": "A String", # Required. The type of query. }, - "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Optional. Legacy metadata associated with this scenario/monitor. - "aggregationEnabled": True or False, # Optional. Whether aggregation is enabled for alerts from this monitor. - "aggregationSimilarity": 3.14, # Optional. Similarity threshold for aggregation. - "conditionVersion": 42, # Optional. Version of the condition schema. - "creatorUserId": "A String", # Optional. User ID who created the monitor. - "description": "A String", # Optional. Description of the legacy monitor. - "disabledCode": "A String", # Optional. Code indicating why the monitor is disabled (if applicable). - "disabledReason": "A String", # Optional. Reason why the monitor is disabled (if applicable). - "displayName": "A String", # Optional. Name of the legacy monitor. - "emailNotificationEnabled": True or False, # Optional. Whether email notifications are enabled. - "emailNotificationImmediate": True or False, # Optional. Whether email notifications are intermediate/immediate. - "legacyMonitorId": "A String", # Optional. Unique identifier of the legacy monitor. - "staleTime": "A String", # Optional. Time the legacy monitor was considered stale. - "templateId": "A String", # Optional. ID of the template this monitor was created from. - "tenantId": "A String", # Optional. ID of the tenant owning the monitor. - "updaterUserId": "A String", # Optional. User ID who last updated the monitor. - "version": 42, # Optional. Version of the monitor configuration. + "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Output only. Legacy metadata associated with this scenario/monitor. + "aggregationEnabled": True or False, # Output only. Whether aggregation is enabled for alerts from this monitor. + "aggregationSimilarity": 3.14, # Output only. Similarity threshold for aggregation. + "conditionVersion": 42, # Output only. Version of the condition schema. + "creatorUserId": "A String", # Output only. User ID who created the monitor. + "description": "A String", # Output only. Description of the legacy monitor. + "disabledCode": "A String", # Output only. Code indicating why the monitor is disabled (if applicable). + "disabledReason": "A String", # Output only. Reason why the monitor is disabled (if applicable). + "displayName": "A String", # Output only. Name of the legacy monitor. + "emailNotificationEnabled": True or False, # Output only. Deprecated: Whether email notifications are enabled. This field will not be used as email notifications are handled through the GTI Mail Hub. + "emailNotificationImmediate": True or False, # Output only. Deprecated: Whether email notifications are intermediate/immediate. This field will not be used as email notifications are handled through the GTI Mail Hub. + "legacyMonitorId": "A String", # Output only. Unique identifier of the legacy monitor. + "staleTime": "A String", # Output only. Time the legacy monitor was considered stale. + "templateId": "A String", # Output only. ID of the template this monitor was created from. + "tenantId": "A String", # Output only. ID of the tenant owning the monitor. + "updaterUserId": "A String", # Output only. User ID who last updated the monitor. + "version": 42, # Output only. Version of the monitor configuration. }, }, "customerProfile": { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config. @@ -381,23 +381,23 @@

Method Details

"query": "A String", # Required. The query string. "queryType": "A String", # Required. The type of query. }, - "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Optional. Legacy metadata associated with this scenario/monitor. - "aggregationEnabled": True or False, # Optional. Whether aggregation is enabled for alerts from this monitor. - "aggregationSimilarity": 3.14, # Optional. Similarity threshold for aggregation. - "conditionVersion": 42, # Optional. Version of the condition schema. - "creatorUserId": "A String", # Optional. User ID who created the monitor. - "description": "A String", # Optional. Description of the legacy monitor. - "disabledCode": "A String", # Optional. Code indicating why the monitor is disabled (if applicable). - "disabledReason": "A String", # Optional. Reason why the monitor is disabled (if applicable). - "displayName": "A String", # Optional. Name of the legacy monitor. - "emailNotificationEnabled": True or False, # Optional. Whether email notifications are enabled. - "emailNotificationImmediate": True or False, # Optional. Whether email notifications are intermediate/immediate. - "legacyMonitorId": "A String", # Optional. Unique identifier of the legacy monitor. - "staleTime": "A String", # Optional. Time the legacy monitor was considered stale. - "templateId": "A String", # Optional. ID of the template this monitor was created from. - "tenantId": "A String", # Optional. ID of the tenant owning the monitor. - "updaterUserId": "A String", # Optional. User ID who last updated the monitor. - "version": 42, # Optional. Version of the monitor configuration. + "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Output only. Legacy metadata associated with this scenario/monitor. + "aggregationEnabled": True or False, # Output only. Whether aggregation is enabled for alerts from this monitor. + "aggregationSimilarity": 3.14, # Output only. Similarity threshold for aggregation. + "conditionVersion": 42, # Output only. Version of the condition schema. + "creatorUserId": "A String", # Output only. User ID who created the monitor. + "description": "A String", # Output only. Description of the legacy monitor. + "disabledCode": "A String", # Output only. Code indicating why the monitor is disabled (if applicable). + "disabledReason": "A String", # Output only. Reason why the monitor is disabled (if applicable). + "displayName": "A String", # Output only. Name of the legacy monitor. + "emailNotificationEnabled": True or False, # Output only. Deprecated: Whether email notifications are enabled. This field will not be used as email notifications are handled through the GTI Mail Hub. + "emailNotificationImmediate": True or False, # Output only. Deprecated: Whether email notifications are intermediate/immediate. This field will not be used as email notifications are handled through the GTI Mail Hub. + "legacyMonitorId": "A String", # Output only. Unique identifier of the legacy monitor. + "staleTime": "A String", # Output only. Time the legacy monitor was considered stale. + "templateId": "A String", # Output only. ID of the template this monitor was created from. + "tenantId": "A String", # Output only. ID of the tenant owning the monitor. + "updaterUserId": "A String", # Output only. User ID who last updated the monitor. + "version": 42, # Output only. Version of the monitor configuration. }, }, "customerProfile": { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config. @@ -637,23 +637,23 @@

Method Details

"query": "A String", # Required. The query string. "queryType": "A String", # Required. The type of query. }, - "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Optional. Legacy metadata associated with this scenario/monitor. - "aggregationEnabled": True or False, # Optional. Whether aggregation is enabled for alerts from this monitor. - "aggregationSimilarity": 3.14, # Optional. Similarity threshold for aggregation. - "conditionVersion": 42, # Optional. Version of the condition schema. - "creatorUserId": "A String", # Optional. User ID who created the monitor. - "description": "A String", # Optional. Description of the legacy monitor. - "disabledCode": "A String", # Optional. Code indicating why the monitor is disabled (if applicable). - "disabledReason": "A String", # Optional. Reason why the monitor is disabled (if applicable). - "displayName": "A String", # Optional. Name of the legacy monitor. - "emailNotificationEnabled": True or False, # Optional. Whether email notifications are enabled. - "emailNotificationImmediate": True or False, # Optional. Whether email notifications are intermediate/immediate. - "legacyMonitorId": "A String", # Optional. Unique identifier of the legacy monitor. - "staleTime": "A String", # Optional. Time the legacy monitor was considered stale. - "templateId": "A String", # Optional. ID of the template this monitor was created from. - "tenantId": "A String", # Optional. ID of the tenant owning the monitor. - "updaterUserId": "A String", # Optional. User ID who last updated the monitor. - "version": 42, # Optional. Version of the monitor configuration. + "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Output only. Legacy metadata associated with this scenario/monitor. + "aggregationEnabled": True or False, # Output only. Whether aggregation is enabled for alerts from this monitor. + "aggregationSimilarity": 3.14, # Output only. Similarity threshold for aggregation. + "conditionVersion": 42, # Output only. Version of the condition schema. + "creatorUserId": "A String", # Output only. User ID who created the monitor. + "description": "A String", # Output only. Description of the legacy monitor. + "disabledCode": "A String", # Output only. Code indicating why the monitor is disabled (if applicable). + "disabledReason": "A String", # Output only. Reason why the monitor is disabled (if applicable). + "displayName": "A String", # Output only. Name of the legacy monitor. + "emailNotificationEnabled": True or False, # Output only. Deprecated: Whether email notifications are enabled. This field will not be used as email notifications are handled through the GTI Mail Hub. + "emailNotificationImmediate": True or False, # Output only. Deprecated: Whether email notifications are intermediate/immediate. This field will not be used as email notifications are handled through the GTI Mail Hub. + "legacyMonitorId": "A String", # Output only. Unique identifier of the legacy monitor. + "staleTime": "A String", # Output only. Time the legacy monitor was considered stale. + "templateId": "A String", # Output only. ID of the template this monitor was created from. + "tenantId": "A String", # Output only. ID of the tenant owning the monitor. + "updaterUserId": "A String", # Output only. User ID who last updated the monitor. + "version": 42, # Output only. Version of the monitor configuration. }, }, "customerProfile": { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config. diff --git a/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html b/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html index 6111ca213a..b73252aec7 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html +++ b/docs/dyn/threatintelligence_v1beta.projects.configurations.revisions.html @@ -130,23 +130,23 @@

Method Details

"query": "A String", # Required. The query string. "queryType": "A String", # Required. The type of query. }, - "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Optional. Legacy metadata associated with this scenario/monitor. - "aggregationEnabled": True or False, # Optional. Whether aggregation is enabled for alerts from this monitor. - "aggregationSimilarity": 3.14, # Optional. Similarity threshold for aggregation. - "conditionVersion": 42, # Optional. Version of the condition schema. - "creatorUserId": "A String", # Optional. User ID who created the monitor. - "description": "A String", # Optional. Description of the legacy monitor. - "disabledCode": "A String", # Optional. Code indicating why the monitor is disabled (if applicable). - "disabledReason": "A String", # Optional. Reason why the monitor is disabled (if applicable). - "displayName": "A String", # Optional. Name of the legacy monitor. - "emailNotificationEnabled": True or False, # Optional. Whether email notifications are enabled. - "emailNotificationImmediate": True or False, # Optional. Whether email notifications are intermediate/immediate. - "legacyMonitorId": "A String", # Optional. Unique identifier of the legacy monitor. - "staleTime": "A String", # Optional. Time the legacy monitor was considered stale. - "templateId": "A String", # Optional. ID of the template this monitor was created from. - "tenantId": "A String", # Optional. ID of the tenant owning the monitor. - "updaterUserId": "A String", # Optional. User ID who last updated the monitor. - "version": 42, # Optional. Version of the monitor configuration. + "legacyMonitorMetadata": { # Legacy metadata associated with this scenario/monitor. # Output only. Legacy metadata associated with this scenario/monitor. + "aggregationEnabled": True or False, # Output only. Whether aggregation is enabled for alerts from this monitor. + "aggregationSimilarity": 3.14, # Output only. Similarity threshold for aggregation. + "conditionVersion": 42, # Output only. Version of the condition schema. + "creatorUserId": "A String", # Output only. User ID who created the monitor. + "description": "A String", # Output only. Description of the legacy monitor. + "disabledCode": "A String", # Output only. Code indicating why the monitor is disabled (if applicable). + "disabledReason": "A String", # Output only. Reason why the monitor is disabled (if applicable). + "displayName": "A String", # Output only. Name of the legacy monitor. + "emailNotificationEnabled": True or False, # Output only. Deprecated: Whether email notifications are enabled. This field will not be used as email notifications are handled through the GTI Mail Hub. + "emailNotificationImmediate": True or False, # Output only. Deprecated: Whether email notifications are intermediate/immediate. This field will not be used as email notifications are handled through the GTI Mail Hub. + "legacyMonitorId": "A String", # Output only. Unique identifier of the legacy monitor. + "staleTime": "A String", # Output only. Time the legacy monitor was considered stale. + "templateId": "A String", # Output only. ID of the template this monitor was created from. + "tenantId": "A String", # Output only. ID of the tenant owning the monitor. + "updaterUserId": "A String", # Output only. User ID who last updated the monitor. + "version": 42, # Output only. Version of the monitor configuration. }, }, "customerProfile": { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config. diff --git a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json index e2ff4db375..518e518087 100644 --- a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json +++ b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json @@ -842,7 +842,7 @@ } } }, -"revision": "20260823", +"revision": "20260830", "rootUrl": "https://threatintelligence.googleapis.com/", "schemas": { "Alert": { @@ -1274,7 +1274,8 @@ }, "legacyMonitorMetadata": { "$ref": "LegacyMetadata", -"description": "Optional. Legacy metadata associated with this scenario/monitor." +"description": "Output only. Legacy metadata associated with this scenario/monitor.", +"readOnly": true } }, "type": "object" @@ -2098,71 +2099,89 @@ "id": "LegacyMetadata", "properties": { "aggregationEnabled": { -"description": "Optional. Whether aggregation is enabled for alerts from this monitor.", +"description": "Output only. Whether aggregation is enabled for alerts from this monitor.", +"readOnly": true, "type": "boolean" }, "aggregationSimilarity": { -"description": "Optional. Similarity threshold for aggregation.", +"description": "Output only. Similarity threshold for aggregation.", "format": "double", +"readOnly": true, "type": "number" }, "conditionVersion": { -"description": "Optional. Version of the condition schema.", +"description": "Output only. Version of the condition schema.", "format": "int32", +"readOnly": true, "type": "integer" }, "creatorUserId": { -"description": "Optional. User ID who created the monitor.", +"description": "Output only. User ID who created the monitor.", +"readOnly": true, "type": "string" }, "description": { -"description": "Optional. Description of the legacy monitor.", +"description": "Output only. Description of the legacy monitor.", +"readOnly": true, "type": "string" }, "disabledCode": { -"description": "Optional. Code indicating why the monitor is disabled (if applicable).", +"description": "Output only. Code indicating why the monitor is disabled (if applicable).", +"readOnly": true, "type": "string" }, "disabledReason": { -"description": "Optional. Reason why the monitor is disabled (if applicable).", +"description": "Output only. Reason why the monitor is disabled (if applicable).", +"readOnly": true, "type": "string" }, "displayName": { -"description": "Optional. Name of the legacy monitor.", +"description": "Output only. Name of the legacy monitor.", +"readOnly": true, "type": "string" }, "emailNotificationEnabled": { -"description": "Optional. Whether email notifications are enabled.", +"deprecated": true, +"description": "Output only. Deprecated: Whether email notifications are enabled. This field will not be used as email notifications are handled through the GTI Mail Hub.", +"readOnly": true, "type": "boolean" }, "emailNotificationImmediate": { -"description": "Optional. Whether email notifications are intermediate/immediate.", +"deprecated": true, +"description": "Output only. Deprecated: Whether email notifications are intermediate/immediate. This field will not be used as email notifications are handled through the GTI Mail Hub.", +"readOnly": true, "type": "boolean" }, "legacyMonitorId": { -"description": "Optional. Unique identifier of the legacy monitor.", +"description": "Output only. Unique identifier of the legacy monitor.", +"readOnly": true, "type": "string" }, "staleTime": { -"description": "Optional. Time the legacy monitor was considered stale.", +"description": "Output only. Time the legacy monitor was considered stale.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "templateId": { -"description": "Optional. ID of the template this monitor was created from.", +"description": "Output only. ID of the template this monitor was created from.", +"readOnly": true, "type": "string" }, "tenantId": { -"description": "Optional. ID of the tenant owning the monitor.", +"description": "Output only. ID of the tenant owning the monitor.", +"readOnly": true, "type": "string" }, "updaterUserId": { -"description": "Optional. User ID who last updated the monitor.", +"description": "Output only. User ID who last updated the monitor.", +"readOnly": true, "type": "string" }, "version": { -"description": "Optional. Version of the monitor configuration.", +"description": "Output only. Version of the monitor configuration.", "format": "int32", +"readOnly": true, "type": "integer" } }, From a3dd0bfae8602d2af41f60f99266640045b6e682 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:19 +0000 Subject: [PATCH 36/40] feat(webcontentpublisher): update the api #### webcontentpublisher:v1 The following keys were added: - schemas.DomainProperty.properties.ownershipVerified.readOnly (Total Keys: 1) --- ...blisher_v1.organizations.publications.html | 24 +++++++++---------- .../documents/webcontentpublisher.v1.json | 5 ++-- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/dyn/webcontentpublisher_v1.organizations.publications.html b/docs/dyn/webcontentpublisher_v1.organizations.publications.html index ecb6cd553b..3a43416164 100644 --- a/docs/dyn/webcontentpublisher_v1.organizations.publications.html +++ b/docs/dyn/webcontentpublisher_v1.organizations.publications.html @@ -115,7 +115,7 @@

Method Details

{ # Represents a publisher's publication in Reader Revenue Manager. "additionalDomains": [ # Optional. Additional domain properties verified for the publication. { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, ], @@ -130,7 +130,7 @@

Method Details

"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication. "paymentOption": "A String", # Output only. The configured payment option. "primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, "products": [ # Output only. The list of active products/features enabled for this publication. @@ -167,7 +167,7 @@

Method Details

{ # Represents a publisher's publication in Reader Revenue Manager. "additionalDomains": [ # Optional. Additional domain properties verified for the publication. { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, ], @@ -182,7 +182,7 @@

Method Details

"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication. "paymentOption": "A String", # Output only. The configured payment option. "primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, "products": [ # Output only. The list of active products/features enabled for this publication. @@ -225,7 +225,7 @@

Method Details

{ # Represents a publisher's publication in Reader Revenue Manager. "additionalDomains": [ # Optional. Additional domain properties verified for the publication. { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, ], @@ -240,7 +240,7 @@

Method Details

"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication. "paymentOption": "A String", # Output only. The configured payment option. "primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, "products": [ # Output only. The list of active products/features enabled for this publication. @@ -289,7 +289,7 @@

Method Details

{ # Represents a publisher's publication in Reader Revenue Manager. "additionalDomains": [ # Optional. Additional domain properties verified for the publication. { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, ], @@ -304,7 +304,7 @@

Method Details

"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication. "paymentOption": "A String", # Output only. The configured payment option. "primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, "products": [ # Output only. The list of active products/features enabled for this publication. @@ -358,7 +358,7 @@

Method Details

{ # Represents a publisher's publication in Reader Revenue Manager. "additionalDomains": [ # Optional. Additional domain properties verified for the publication. { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, ], @@ -373,7 +373,7 @@

Method Details

"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication. "paymentOption": "A String", # Output only. The configured payment option. "primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, "products": [ # Output only. The list of active products/features enabled for this publication. @@ -410,7 +410,7 @@

Method Details

{ # Represents a publisher's publication in Reader Revenue Manager. "additionalDomains": [ # Optional. Additional domain properties verified for the publication. { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, ], @@ -425,7 +425,7 @@

Method Details

"organizationId": "A String", # Output only. The unique identifier of the organization that owns this publication. "paymentOption": "A String", # Output only. The configured payment option. "primaryDomain": { # Represents a domain property associated with a publication, typically used to verify ownership and scope access. # Required. The primary domain property associated with the publication. - "ownershipVerified": True or False, # Optional. Whether the domain ownership has been verified (e.g., via Google Search Console). + "ownershipVerified": True or False, # Output only. Whether the domain ownership has been verified (e.g., via Google Search Console). "url": "A String", # Required. The URL of the domain property (e.g., "https://example.com"). }, "products": [ # Output only. The list of active products/features enabled for this publication. diff --git a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json index a28112be43..4f3575950d 100644 --- a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json +++ b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json @@ -413,7 +413,7 @@ } } }, -"revision": "20260827", +"revision": "20260902", "rootUrl": "https://webcontentpublisher.googleapis.com/", "schemas": { "CheckFreeAccessResponse": { @@ -514,7 +514,8 @@ "id": "DomainProperty", "properties": { "ownershipVerified": { -"description": "Optional. Whether the domain ownership has been verified (e.g., via Google Search Console).", +"description": "Output only. Whether the domain ownership has been verified (e.g., via Google Search Console).", +"readOnly": true, "type": "boolean" }, "url": { From 96bbecb93bae8964fd1de80df7891a39f6575750 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:19 +0000 Subject: [PATCH 37/40] feat(workflowexecutions): update the api #### workflowexecutions:v1 The following keys were added: - endpoints (Total Keys: 1) #### workflowexecutions:v1beta The following keys were added: - endpoints (Total Keys: 1) --- .../documents/workflowexecutions.v1.json | 204 +++++++++++++++++- .../documents/workflowexecutions.v1beta.json | 204 +++++++++++++++++- 2 files changed, 406 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index 960c64de52..cd2b910e66 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -15,6 +15,208 @@ "description": "Execute workflows created with Workflows API.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/workflows", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -517,7 +719,7 @@ } } }, -"revision": "20250211", +"revision": "20260825", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json index c31a055cea..0880b0018e 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json @@ -15,6 +15,208 @@ "description": "Execute workflows created with Workflows API.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/workflows", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.us-west8.rep.googleapis.com/", +"location": "us-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workflowexecutions.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -269,7 +471,7 @@ } } }, -"revision": "20240625", +"revision": "20260825", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { From 28398bf4807621b1b86ba0305b85842a33dba48f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:19 +0000 Subject: [PATCH 38/40] feat(workstations): update the api #### workstations:v1 The following keys were added: - resources.projects.resources.locations.resources.workstationClusters.resources.workstationConfigs.resources.workstations.methods.suspend (Total Keys: 12) - schemas.SuspendWorkstationRequest (Total Keys: 3) - schemas.WorkstationConfig.properties.idleAction.type (Total Keys: 1) --- ...orkstationClusters.workstationConfigs.html | 25 ++++--- ...sters.workstationConfigs.workstations.html | 46 ++++++++++++ ...rojects.locations.workstationClusters.html | 4 ++ ...orkstationClusters.workstationConfigs.html | 20 +++--- .../documents/workstations.v1.json | 71 +++++++++++++++++-- .../documents/workstations.v1beta.json | 10 ++- 6 files changed, 148 insertions(+), 28 deletions(-) diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index bc9fd4a46f..66bcbfffc2 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -242,7 +242,8 @@

Method Details

}, }, }, - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -279,7 +280,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } @@ -479,7 +480,8 @@

Method Details

}, }, }, - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -516,7 +518,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }
@@ -705,7 +707,8 @@

Method Details

}, }, }, - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -742,7 +745,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -884,7 +887,8 @@

Method Details

}, }, }, - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -921,7 +925,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -1078,7 +1082,8 @@

Method Details

}, }, }, - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -1115,7 +1120,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html index d4cff1630e..a0dbe87664 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -116,6 +116,9 @@

Instance Methods

stop(name, body=None, x__xgafv=None)

Stops running a workstation, reducing costs.

+

+ suspend(name, body=None, x__xgafv=None)

+

Suspends a workstation to reduce costs.

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@@ -776,6 +779,49 @@

Method Details

}
+
+ suspend(name, body=None, x__xgafv=None) +
Suspends a workstation to reduce costs.
+
+Args:
+  name: string, Required. Name of the workstation to suspend. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SuspendWorkstation.
+  "etag": "A String", # Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
+  "validateOnly": True or False, # Optional. If set, validate the request and preview the result, but do not actually apply it.
+}
+
+  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.
+  },
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html
index 7c9b4489a0..8ca1561d53 100644
--- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html
+++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html
@@ -130,6 +130,7 @@ 

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "consoleBaseUrl": "A String", # Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set. "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "createTime": "A String", # Output only. Time when this workstation cluster was created. "degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. @@ -266,6 +267,7 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "consoleBaseUrl": "A String", # Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set. "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "createTime": "A String", # Output only. Time when this workstation cluster was created. "degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. @@ -343,6 +345,7 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "consoleBaseUrl": "A String", # Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set. "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "createTime": "A String", # Output only. Time when this workstation cluster was created. "degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. @@ -422,6 +425,7 @@

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "consoleBaseUrl": "A String", # Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set. "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "createTime": "A String", # Output only. Time when this workstation cluster was created. "degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 99d368014a..1f9e8942cc 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -262,7 +262,7 @@

Method Details

"disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -301,7 +301,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -523,7 +523,7 @@

Method Details

"disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -562,7 +562,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -773,7 +773,7 @@

Method Details

"disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -812,7 +812,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -976,7 +976,7 @@

Method Details

"disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -1015,7 +1015,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. @@ -1194,7 +1194,7 @@

Method Details

"disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. - "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). + "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", }, @@ -1233,7 +1233,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index f28eb6b202..c3cdcf9c29 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1189,6 +1189,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"suspend": { +"description": "Suspends a workstation to reduce costs.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:suspend", +"httpMethod": "POST", +"id": "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.suspend", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the workstation to suspend.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:suspend", +"request": { +"$ref": "SuspendWorkstationRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions", @@ -1228,7 +1256,7 @@ } } }, -"revision": "20260807", +"revision": "20260901", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2270,6 +2298,21 @@ }, "type": "object" }, +"SuspendWorkstationRequest": { +"description": "Request message for SuspendWorkstation.", +"id": "SuspendWorkstationRequest", +"properties": { +"etag": { +"description": "Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.", +"type": "boolean" +} +}, +"type": "object" +}, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -2391,14 +2434,18 @@ "STATE_STARTING", "STATE_RUNNING", "STATE_STOPPING", -"STATE_STOPPED" +"STATE_STOPPED", +"STATE_SUSPENDING", +"STATE_SUSPENDED" ], "enumDescriptions": [ "Do not use.", "The workstation is not yet ready to accept requests from users but will be soon.", "The workstation is ready to accept requests from users.", "The workstation is being stopped.", -"The workstation is stopped and will not be able to receive requests until it is started." +"The workstation is stopped and will not be able to receive requests until it is started.", +"The workstation is being suspended.", +"The workstation is suspended." ], "readOnly": true, "type": "string" @@ -2613,8 +2660,22 @@ "$ref": "Host", "description": "Optional. Runtime host for the workstation." }, +"idleAction": { +"description": "Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP.", +"enum": [ +"IDLE_ACTION_UNSPECIFIED", +"STOP", +"SUSPEND" +], +"enumDescriptions": [ +"Defaults to STOP.", +"Stop the workstation after idle_timeout.", +"Suspend the workstation after idle_timeout." +], +"type": "string" +}, "idleTimeout": { -"description": "Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds\u2014for example, `\"7200s\"` (2 hours). The default is `\"1200s\"` (20 minutes).", +"description": "Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds\u2014for example, `\"7200s\"` (2 hours). The default is `\"1200s\"` (20 minutes).", "format": "google-duration", "type": "string" }, @@ -2661,7 +2722,7 @@ "type": "array" }, "runningTimeout": { -"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", +"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 7b7762d4e2..c0f8e32987 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1210,7 +1210,7 @@ } } }, -"revision": "20260819", +"revision": "20260901", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2540,6 +2540,10 @@ "readOnly": true, "type": "array" }, +"consoleBaseUrl": { +"description": "Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set.", +"type": "string" +}, "controlPlaneIp": { "description": "Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.", "readOnly": true, @@ -2750,7 +2754,7 @@ "type": "string" }, "idleTimeout": { -"description": "Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds\u2014for example, `\"7200s\"` (2 hours). The default is `\"1200s\"` (20 minutes).", +"description": "Optional. Number of seconds to wait before automatically stopping or suspending a workstation after it last received user traffic. See idle_action to configure whether to stop or suspend idle workstations. A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds\u2014for example, `\"7200s\"` (2 hours). The default is `\"1200s\"` (20 minutes).", "format": "google-duration", "type": "string" }, @@ -2797,7 +2801,7 @@ "type": "array" }, "runningTimeout": { -"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", +"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", "format": "google-duration", "type": "string" }, From fab00c9bc4592f1646684bfbf2ee3f2976e5678b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:19 +0000 Subject: [PATCH 39/40] fix(youtube): update the api #### youtube:v3 The following keys were changed: - resources.videos.methods.getRating.scopes (Total Keys: 1) --- googleapiclient/discovery_cache/documents/youtube.v3.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index b718ffd26e..1f0fa310ce 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -3745,6 +3745,7 @@ "scopes": [ "https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl", +"https://www.googleapis.com/auth/youtube.readonly", "https://www.googleapis.com/auth/youtubepartner" ] }, @@ -4192,7 +4193,7 @@ } } }, -"revision": "20260820", +"revision": "20260902", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { From e18005c8af5b2a9ea7284766de4ff9a164d9752e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 8 Sep 2026 07:20:20 +0000 Subject: [PATCH 40/40] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...try_v1alpha.projects.locations.skills.html | 6 +- docs/dyn/aiplatform_v1.endpoints.html | 12 + docs/dyn/aiplatform_v1.html | 5 + ...platform_v1.projects.locations.agents.html | 32 +- ...tform_v1.projects.locations.endpoints.html | 12 + ....projects.locations.evaluationMetrics.html | 32 + ..._v1.projects.locations.evaluationRuns.html | 160 ++ .../dyn/aiplatform_v1.projects.locations.html | 41 + ...1.projects.locations.onlineEvaluators.html | 32 + ....projects.locations.publishers.models.html | 12 + ....locations.semanticGovernancePolicies.html | 12 + ...form_v1.projects.locations.taskStores.html | 91 + ...jects.locations.taskStores.operations.html | 272 ++ ...form_v1.projects.locations.tuningJobs.html | 80 + docs/dyn/aiplatform_v1.publishers.models.html | 12 + docs/dyn/aiplatform_v1.taskStores.html | 91 + .../aiplatform_v1.taskStores.operations.html | 272 ++ docs/dyn/aiplatform_v1.v1.html | 36 + docs/dyn/aiplatform_v1beta1.endpoints.html | 12 + docs/dyn/aiplatform_v1beta1.html | 5 + docs/dyn/aiplatform_v1beta1.interactions.html | 217 ++ ...orm_v1beta1.projects.locations.agents.html | 32 +- ...m_v1beta1.projects.locations.datasets.html | 8 + ..._v1beta1.projects.locations.endpoints.html | 12 + ....projects.locations.evaluationMetrics.html | 48 +- ...ta1.projects.locations.evaluationRuns.html | 176 +- ...aiplatform_v1beta1.projects.locations.html | 58 +- ...beta1.projects.locations.interactions.html | 249 ++ ...1.projects.locations.interactionsHttp.html | 188 ++ ...1.projects.locations.onlineEvaluators.html | 48 +- ....projects.locations.publishers.models.html | 12 + ...ngEngines.sandboxEnvironmentSnapshots.html | 2 + ...ngEngines.sandboxEnvironmentTemplates.html | 3 + ....reasoningEngines.sandboxEnvironments.html | 53 + ....locations.semanticGovernancePolicies.html | 12 + ...ions.taskStores.a2aTaskRecords.events.html | 232 ++ ...s.locations.taskStores.a2aTaskRecords.html | 850 +++++++ ...v1beta1.projects.locations.taskStores.html | 96 + ...jects.locations.taskStores.operations.html | 272 ++ ...v1beta1.projects.locations.tuningJobs.html | 148 +- .../aiplatform_v1beta1.publishers.models.html | 12 + ...ngEngines.sandboxEnvironmentSnapshots.html | 2 + ...ngEngines.sandboxEnvironmentTemplates.html | 3 + ....reasoningEngines.sandboxEnvironments.html | 53 + docs/dyn/aiplatform_v1beta1.taskStores.html | 91 + ...latform_v1beta1.taskStores.operations.html | 272 ++ docs/dyn/aiplatform_v1beta1.v1beta1.html | 48 +- ...ueryreservation_v1.projects.locations.html | 4 +- ...ts.locations.reservations.assignments.html | 12 +- docs/dyn/chat_v1.spaces.html | 4 +- docs/dyn/chat_v1.spaces.messages.html | 2 +- ...oudkms_v1.projects.locations.keyRings.html | 4 +- ...v1.accountTypes.accounts.partnerLinks.html | 2 +- docs/dyn/developerknowledge_v1.documents.html | 6 +- docs/dyn/developerknowledge_v1.v1.html | 2 +- .../developerknowledge_v1alpha.documents.html | 6 +- .../developerknowledge_v1alpha.v1alpha.html | 2 +- docs/dyn/displayvideo_v2.advertisers.html | 12 +- ...displayvideo_v2.advertisers.lineItems.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- ...yvideo_v2.advertisers.youtubeAdGroups.html | 4 +- ...rgetingTypes.assignedTargetingOptions.html | 8 +- docs/dyn/displayvideo_v2.partners.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- ...isplayvideo_v3.advertisers.adGroupAds.html | 12 +- .../displayvideo_v3.advertisers.adGroups.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- docs/dyn/displayvideo_v3.advertisers.html | 12 +- ...displayvideo_v3.advertisers.lineItems.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- docs/dyn/displayvideo_v3.partners.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- ...isplayvideo_v4.advertisers.adGroupAds.html | 12 +- .../displayvideo_v4.advertisers.adGroups.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- docs/dyn/displayvideo_v4.advertisers.html | 12 +- ...displayvideo_v4.advertisers.lineItems.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- docs/dyn/displayvideo_v4.partners.html | 8 +- ...rgetingTypes.assignedTargetingOptions.html | 16 +- docs/dyn/docs_v1.documents.html | 2 +- ...cts.databases.collectionGroups.fields.html | 6 +- ...ts.databases.collectionGroups.indexes.html | 6 +- .../documents/agenciesandbrands.v1.json | 6 +- .../documents/agentregistry.v1alpha.json | 8 +- .../documents/aiplatform.v1.json | 976 +++++++- .../documents/aiplatform.v1beta1.json | 2218 ++++++++++++++++- .../documents/bigqueryreservation.v1.json | 4 +- .../discovery_cache/documents/chat.v1.json | 8 +- .../documents/cloudkms.v1.json | 4 +- .../documents/curationpartners.v1.json | 6 +- .../documents/datamanager.v1.json | 4 +- .../documents/developerknowledge.v1.json | 4 +- .../documents/developerknowledge.v1alpha.json | 4 +- .../documents/displayvideo.v2.json | 98 +- .../documents/displayvideo.v3.json | 100 +- .../documents/displayvideo.v4.json | 100 +- .../discovery_cache/documents/docs.v1.json | 4 +- .../documents/firestore.v1.json | 4 +- 102 files changed, 7830 insertions(+), 512 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.projects.locations.taskStores.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.taskStores.operations.html create mode 100644 docs/dyn/aiplatform_v1.taskStores.html create mode 100644 docs/dyn/aiplatform_v1.taskStores.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.interactionsHttp.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.taskStores.html create mode 100644 docs/dyn/aiplatform_v1beta1.taskStores.operations.html diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html index bab16da993..06135d7d3b 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html @@ -326,7 +326,7 @@

Method Details

Args: parent: string, Required. Parent value for ListSkillsRequest (required) - filter: string, Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`. + filter: string, Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. orderBy: string, Optional. Hint for how to order the results pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. pageToken: string, Optional. A token identifying a page of results the server should return. @@ -503,10 +503,10 @@

Method Details

Args: parent: string, Required. Parent value for SearchSkillsRequest. Format: `projects/{project}/locations/{location}`. (required) - filter: string, Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`. + filter: string, Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. pageSize: integer, Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested. pageToken: string, Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call. - searchString: string, Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |----------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | publisher | No | Yes | Yes | Excluded | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | | frontmatter.metadata. | No | Yes | No | Excluded | | attributes.. | No | Yes | No | Excluded | Examples: * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`. * `frontmatter.metadata.author:alice` to find skills whose frontmatter metadata `author` contains words that start with `alice`. + searchString: string, Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`. searchType: string, Optional. The type of search. Allowed values SEARCH_TYPE_UNSPECIFIED - Invalid search type. diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 4838c53d72..fe714ace5b 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -504,6 +504,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -1155,6 +1159,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -2166,6 +2174,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1.html b/docs/dyn/aiplatform_v1.html index 7f46223471..0d30919da5 100644 --- a/docs/dyn/aiplatform_v1.html +++ b/docs/dyn/aiplatform_v1.html @@ -254,6 +254,11 @@

Instance Methods

Returns the studies Resource.

+

+ taskStores() +

+

Returns the taskStores Resource.

+

tensorboards()

diff --git a/docs/dyn/aiplatform_v1.projects.locations.agents.html b/docs/dyn/aiplatform_v1.projects.locations.agents.html index 88058c5111..814061c9a5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.agents.html @@ -136,9 +136,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -240,9 +240,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -290,7 +290,7 @@

Method Details

Args: parent: string, Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`. (required) - filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields: * `created` * `updated` Both are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. Example: `created > "2026-08-01T00:00:00Z" AND updated < "2026-08-09T00:00:00Z"`. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`. + filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields, and the operators each accepts: * `created` * `updated` * `base_agent` * `metadata.agent_type` `created` and `updated` are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. `metadata.agent_type` accepts only the value `"default_agent"`, matched exactly: `metadata.agent_type:"default_agent"` selects the caller's default agent, of which there is at most one, and the negated form selects the rest. Any other value is `INVALID_ARGUMENT` rather than an empty page -- `metadata` is an opaque blob, so only this one marker is indexed, and the server cannot answer a question about the others. An agent designated before the server began recording the marker is not matched by the positive form; there is no backfill. `base_agent` accepts `=` and `!=` against the value an agent was created with, and selects only among the agents you own: an agent that belongs to the project rather than to a user is never returned by a filter naming it, including the negated form. An agent created before the server began recording the value is not matched either. Example: `created > "2026-08-01T00:00:00Z" AND updated < "2026-08-09T00:00:00Z"`. IMPORTANT -- `base_agent` and `metadata.agent_type` select only among the agents you own. An agent that belongs to the project rather than to a user is never returned by a filter naming either of them, including a negated one: `base_agent != "some-value"` returns your matching agents and no project-owned agents at all. Filtering on `created` or `updated` alone is unaffected and still spans both. If you want every agent in the project, do not filter on these two fields. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`. orderBy: string, Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`. pageSize: integer, Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10. pageToken: string, Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. @@ -321,9 +321,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -373,9 +373,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -407,9 +407,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 990401d6ce..879e1024fa 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -577,6 +577,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -2124,6 +2128,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -4617,6 +4625,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html index a2ff1b1344..31bcfdf048 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html @@ -302,6 +302,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -480,6 +484,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -740,6 +748,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -918,6 +930,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1219,6 +1235,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1397,6 +1417,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1669,6 +1693,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1847,6 +1875,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index ad32e649b6..a589dce8b7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -328,6 +328,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -528,6 +532,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -701,6 +709,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -898,6 +910,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1076,6 +1092,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1311,6 +1331,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1478,6 +1502,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1674,6 +1702,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1875,6 +1907,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -2281,6 +2317,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. @@ -2500,6 +2540,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2700,6 +2744,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2873,6 +2921,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3070,6 +3122,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3248,6 +3304,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3483,6 +3543,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3650,6 +3714,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3846,6 +3914,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4047,6 +4119,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -4453,6 +4529,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. @@ -4714,6 +4794,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4914,6 +4998,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5087,6 +5175,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5284,6 +5376,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5462,6 +5558,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5697,6 +5797,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5864,6 +5968,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6060,6 +6168,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6261,6 +6373,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -6667,6 +6783,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. @@ -6899,6 +7019,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7099,6 +7223,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7272,6 +7400,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7469,6 +7601,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7647,6 +7783,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7882,6 +8022,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -8049,6 +8193,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -8245,6 +8393,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -8446,6 +8598,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -8852,6 +9008,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 50d7e7b5d6..1087e8b37f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -284,6 +284,11 @@

Instance Methods

Returns the studies Resource.

+

+ taskStores() +

+

Returns the taskStores Resource.

+

tensorboards()

@@ -1761,6 +1766,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1960,6 +1969,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2138,6 +2151,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2399,6 +2416,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4512,6 +4533,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4690,6 +4715,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4930,6 +4959,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5108,6 +5141,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6563,6 +6600,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html index 0869cf6ebb..c021257f92 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html @@ -416,6 +416,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -594,6 +598,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -991,6 +999,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1169,6 +1181,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1510,6 +1526,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1688,6 +1708,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2033,6 +2057,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2211,6 +2239,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 3421037959..9adea17134 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -511,6 +511,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -1326,6 +1330,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -2565,6 +2573,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html index f6e385ef69..603100acbd 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html +++ b/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html @@ -118,6 +118,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. @@ -218,6 +221,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. @@ -258,6 +264,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. @@ -304,6 +313,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. diff --git a/docs/dyn/aiplatform_v1.projects.locations.taskStores.html b/docs/dyn/aiplatform_v1.projects.locations.taskStores.html new file mode 100644 index 0000000000..e48ed0ecc8 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.taskStores.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . projects . locations . taskStores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Platform API . projects . locations . taskStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

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

+

Method Details

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

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -584,6 +588,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -770,6 +778,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -948,6 +960,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1739,6 +1755,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1907,6 +1927,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -2093,6 +2117,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2271,6 +2299,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3069,6 +3101,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3237,6 +3273,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -3423,6 +3463,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3601,6 +3645,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4405,6 +4453,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4573,6 +4625,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -4759,6 +4815,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4937,6 +4997,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5756,6 +5820,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5924,6 +5992,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -6110,6 +6182,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6288,6 +6364,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index edb91211d8..d9172e46e7 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -497,6 +497,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -1148,6 +1152,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -2734,6 +2742,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1.taskStores.html b/docs/dyn/aiplatform_v1.taskStores.html new file mode 100644 index 0000000000..cdcceed5c4 --- /dev/null +++ b/docs/dyn/aiplatform_v1.taskStores.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . taskStores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Platform API . taskStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

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

+

Method Details

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

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -462,6 +466,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -640,6 +648,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -900,6 +912,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3013,6 +3029,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3191,6 +3211,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3431,6 +3455,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3609,6 +3637,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5063,6 +5095,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 52025cdc27..ae981b064d 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -509,6 +509,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -1172,6 +1176,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -2196,6 +2204,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index c51a740d43..8f66369dfb 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -324,6 +324,11 @@

Instance Methods

Returns the studies Resource.

+

+ taskStores() +

+

Returns the taskStores Resource.

+

tensorboards()

diff --git a/docs/dyn/aiplatform_v1beta1.interactions.html b/docs/dyn/aiplatform_v1beta1.interactions.html index 2c6e315a35..6715a21b6b 100644 --- a/docs/dyn/aiplatform_v1beta1.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.interactions.html @@ -471,6 +471,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -820,6 +821,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -1156,6 +1158,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -1562,6 +1565,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -1923,6 +1927,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -2288,6 +2293,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -2643,6 +2649,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -3020,6 +3027,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -3375,6 +3383,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -3750,6 +3759,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4098,6 +4108,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4450,6 +4461,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4822,6 +4834,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4850,6 +4863,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -5202,6 +5217,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -5580,6 +5596,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -5604,6 +5621,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -5943,6 +5962,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -6288,6 +6308,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -6636,6 +6657,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -6988,6 +7010,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -7360,6 +7383,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -7388,6 +7412,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -7740,6 +7766,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -8118,6 +8145,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -8142,6 +8170,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -8481,6 +8511,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -8849,6 +8880,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -9386,6 +9418,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -9735,6 +9768,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -10071,6 +10105,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -10477,6 +10512,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -10838,6 +10874,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -11203,6 +11240,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -11558,6 +11596,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -11935,6 +11974,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -12290,6 +12330,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -12665,6 +12706,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13013,6 +13055,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13365,6 +13408,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13737,6 +13781,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13765,6 +13810,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -14117,6 +14164,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -14495,6 +14543,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -14519,6 +14568,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -14858,6 +14909,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -15203,6 +15255,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -15551,6 +15604,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -15903,6 +15957,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -16275,6 +16330,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -16303,6 +16359,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -16655,6 +16713,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -17033,6 +17092,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -17057,6 +17117,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -17396,6 +17458,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -17764,6 +17827,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -18315,6 +18379,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -18666,6 +18731,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -19037,6 +19103,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -19413,6 +19480,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -19791,6 +19859,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -20158,6 +20227,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -20553,6 +20623,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -20902,6 +20973,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -21238,6 +21310,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -21644,6 +21717,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -22005,6 +22079,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -22370,6 +22445,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -22725,6 +22801,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -23102,6 +23179,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -23457,6 +23535,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -23832,6 +23911,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24180,6 +24260,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24532,6 +24613,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24904,6 +24986,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24932,6 +25015,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -25284,6 +25369,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -25662,6 +25748,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -25686,6 +25773,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -26025,6 +26114,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -26370,6 +26460,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -26718,6 +26809,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -27070,6 +27162,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -27442,6 +27535,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -27470,6 +27564,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -27822,6 +27918,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -28200,6 +28297,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -28224,6 +28322,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -28563,6 +28663,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -28931,6 +29032,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -29446,6 +29548,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -29795,6 +29898,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -30131,6 +30235,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -30537,6 +30642,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -30898,6 +31004,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -31263,6 +31370,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -31618,6 +31726,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -31995,6 +32104,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -32350,6 +32460,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -32725,6 +32836,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33073,6 +33185,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33425,6 +33538,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33797,6 +33911,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33825,6 +33940,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -34177,6 +34294,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -34555,6 +34673,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -34579,6 +34698,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -34918,6 +35039,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -35263,6 +35385,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -35611,6 +35734,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -35963,6 +36087,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -36335,6 +36460,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -36363,6 +36489,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -36715,6 +36843,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -37093,6 +37222,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -37117,6 +37247,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -37456,6 +37588,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -37824,6 +37957,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -38339,6 +38473,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -38688,6 +38823,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -39024,6 +39160,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -39430,6 +39567,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -39791,6 +39929,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -40156,6 +40295,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -40511,6 +40651,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -40888,6 +41029,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -41243,6 +41385,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -41618,6 +41761,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -41966,6 +42110,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -42318,6 +42463,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -42690,6 +42836,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -42718,6 +42865,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -43070,6 +43219,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -43448,6 +43598,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -43472,6 +43623,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -43811,6 +43964,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -44156,6 +44310,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -44504,6 +44659,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -44856,6 +45012,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -45228,6 +45385,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -45256,6 +45414,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -45608,6 +45768,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -45986,6 +46147,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -46010,6 +46172,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -46349,6 +46513,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -46717,6 +46882,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -47232,6 +47398,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -47581,6 +47748,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -47917,6 +48085,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -48323,6 +48492,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -48684,6 +48854,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -49049,6 +49220,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -49404,6 +49576,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -49781,6 +49954,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -50136,6 +50310,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -50511,6 +50686,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -50859,6 +51035,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -51211,6 +51388,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -51583,6 +51761,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -51611,6 +51790,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -51963,6 +52144,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -52341,6 +52523,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -52365,6 +52548,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -52704,6 +52889,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -53049,6 +53235,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -53397,6 +53584,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -53749,6 +53937,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54121,6 +54310,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54149,6 +54339,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -54501,6 +54693,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54879,6 +55072,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54903,6 +55097,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -55242,6 +55438,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -55610,6 +55807,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56103,6 +56301,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56484,6 +56683,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56512,6 +56712,8 @@

Method Details

"name": "A String", "serverName": "A String", }, + "processingCall": { # Streaming delta for a server-initiated media processing step. + }, "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool. "queries": [ # Queries for Retrieval information. @@ -56895,6 +57097,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56919,6 +57122,8 @@

Method Details

}, "serverName": "A String", }, + "processingResult": { # Streaming delta for the result of a server-initiated media processing step. + }, "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -57300,6 +57505,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -57649,6 +57855,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -57997,6 +58204,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -58349,6 +58557,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -58721,6 +58930,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -58749,6 +58959,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -59101,6 +59313,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -59479,6 +59692,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -59503,6 +59717,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -59842,6 +60058,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html index 2102851c6d..072af74cfc 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html @@ -141,9 +141,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -245,9 +245,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -295,7 +295,7 @@

Method Details

Args: parent: string, Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`. (required) - filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields: * `created` * `updated` Both are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. Example: `created > "2026-08-01T00:00:00Z" AND updated < "2026-08-09T00:00:00Z"`. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`. + filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields, and the operators each accepts: * `created` * `updated` * `base_agent` * `metadata.agent_type` `created` and `updated` are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. `metadata.agent_type` accepts only the value `"default_agent"`, matched exactly: `metadata.agent_type:"default_agent"` selects the caller's default agent, of which there is at most one, and the negated form selects the rest. Any other value is `INVALID_ARGUMENT` rather than an empty page -- `metadata` is an opaque blob, so only this one marker is indexed, and the server cannot answer a question about the others. An agent designated before the server began recording the marker is not matched by the positive form; there is no backfill. `base_agent` accepts `=` and `!=` against the value an agent was created with, and selects only among the agents you own: an agent that belongs to the project rather than to a user is never returned by a filter naming it, including the negated form. An agent created before the server began recording the value is not matched either. Example: `created > "2026-08-01T00:00:00Z" AND updated < "2026-08-09T00:00:00Z"`. IMPORTANT -- `base_agent` and `metadata.agent_type` select only among the agents you own. An agent that belongs to the project rather than to a user is never returned by a filter naming either of them, including a negated one: `base_agent != "some-value"` returns your matching agents and no project-owned agents at all. Filtering on `created` or `updated` alone is unaffected and still spans both. If you want every agent in the project, do not filter on these two fields. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`. orderBy: string, Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`. pageSize: integer, Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10. pageToken: string, Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. @@ -326,9 +326,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -378,9 +378,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -412,9 +412,9 @@

Method Details

"headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, - "name": "A String", # Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. - "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + "name": "A String", # Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. + "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` + "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. }, ], "updated": "A String", # Output only. The time the agent was last updated. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index e4443db8de..69ea366f4a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -420,6 +420,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -1093,6 +1097,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 1a7a75e0a3..59620f6597 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -591,6 +591,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -2364,6 +2368,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -5213,6 +5221,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html index 37271c6c7e..fd1278c758 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html @@ -137,7 +137,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -311,6 +311,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -323,7 +327,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -493,6 +497,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -583,7 +591,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -757,6 +765,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -769,7 +781,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -939,6 +951,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1070,7 +1086,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -1244,6 +1260,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1256,7 +1276,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -1426,6 +1446,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1528,7 +1552,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -1702,6 +1726,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1714,7 +1742,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -1884,6 +1912,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index b5173cbf83..4bc5dd0163 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -336,6 +336,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -539,6 +543,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -715,6 +723,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -742,7 +754,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -916,6 +928,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -928,7 +944,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -1098,6 +1114,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1336,6 +1356,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1506,6 +1530,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1705,6 +1733,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4435,6 +4467,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -4851,6 +4887,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. @@ -5073,6 +5113,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5276,6 +5320,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5452,6 +5500,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5479,7 +5531,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -5653,6 +5705,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5665,7 +5721,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -5835,6 +5891,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6073,6 +6133,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6243,6 +6307,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6442,6 +6510,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -9172,6 +9244,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -9588,6 +9664,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. @@ -9852,6 +9932,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10055,6 +10139,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10231,6 +10319,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10258,7 +10350,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -10432,6 +10524,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10444,7 +10540,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -10614,6 +10710,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10852,6 +10952,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -11022,6 +11126,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -11221,6 +11329,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -13951,6 +14063,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -14367,6 +14483,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. @@ -14602,6 +14722,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -14805,6 +14929,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -14981,6 +15109,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -15008,7 +15140,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -15182,6 +15314,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -15194,7 +15330,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -15364,6 +15500,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -15602,6 +15742,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -15772,6 +15916,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -15971,6 +16119,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -18701,6 +18853,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, @@ -19117,6 +19273,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 90dd2202fc..439b176703 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -204,6 +204,11 @@

Instance Methods

Returns the interactions Resource.

+

+ interactionsHttp() +

+

Returns the interactionsHttp Resource.

+

memoryBanks()

@@ -339,6 +344,11 @@

Instance Methods

Returns the studies Resource.

+

+ taskStores() +

+

Returns the taskStores Resource.

+

tensorboards()

@@ -1968,6 +1978,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1997,7 +2011,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -2171,6 +2185,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2183,7 +2201,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -2353,6 +2371,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2617,6 +2639,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5193,7 +5219,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -5367,6 +5393,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5379,7 +5409,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -5549,6 +5579,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5619,7 +5653,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -5793,6 +5827,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5805,7 +5843,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -5975,6 +6013,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7444,6 +7486,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 10a87c5c6e..5d00f7dd5a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -474,6 +474,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -823,6 +824,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -1159,6 +1161,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -1565,6 +1568,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -1926,6 +1930,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -2291,6 +2296,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -2646,6 +2652,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -3023,6 +3030,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -3378,6 +3386,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -3753,6 +3762,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4101,6 +4111,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4453,6 +4464,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4825,6 +4837,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -4853,6 +4866,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -5205,6 +5220,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -5583,6 +5599,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -5607,6 +5624,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -5946,6 +5965,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -6291,6 +6311,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -6639,6 +6660,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -6991,6 +7013,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -7363,6 +7386,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -7391,6 +7415,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -7743,6 +7769,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -8121,6 +8148,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -8145,6 +8173,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -8484,6 +8514,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -8852,6 +8883,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -9377,6 +9409,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -9726,6 +9759,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -10062,6 +10096,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -10468,6 +10503,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -10829,6 +10865,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -11194,6 +11231,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -11549,6 +11587,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -11926,6 +11965,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -12281,6 +12321,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -12656,6 +12697,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13004,6 +13046,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13356,6 +13399,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13728,6 +13772,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -13756,6 +13801,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -14108,6 +14155,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -14486,6 +14534,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -14510,6 +14559,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -14849,6 +14900,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -15194,6 +15246,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -15542,6 +15595,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -15894,6 +15948,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -16266,6 +16321,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -16294,6 +16350,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -16646,6 +16704,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -17024,6 +17083,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -17048,6 +17108,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -17387,6 +17449,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -17755,6 +17818,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -18282,6 +18346,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -18631,6 +18696,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -18967,6 +19033,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -19373,6 +19440,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -19734,6 +19802,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -20099,6 +20168,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -20454,6 +20524,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -20831,6 +20902,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -21186,6 +21258,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -21561,6 +21634,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -21909,6 +21983,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -22261,6 +22336,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -22633,6 +22709,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -22661,6 +22738,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -23013,6 +23092,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -23391,6 +23471,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -23415,6 +23496,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -23754,6 +23837,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24099,6 +24183,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24447,6 +24532,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -24799,6 +24885,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -25171,6 +25258,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -25199,6 +25287,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -25551,6 +25641,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -25929,6 +26020,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -25953,6 +26045,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -26292,6 +26386,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -26660,6 +26755,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -27204,6 +27300,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -27555,6 +27652,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -27926,6 +28024,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -28302,6 +28401,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -28680,6 +28780,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -29047,6 +29148,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -29442,6 +29544,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -29791,6 +29894,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -30127,6 +30231,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -30533,6 +30638,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -30894,6 +31000,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -31259,6 +31366,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -31614,6 +31722,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -31991,6 +32100,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -32346,6 +32456,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -32721,6 +32832,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33069,6 +33181,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33421,6 +33534,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33793,6 +33907,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -33821,6 +33936,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -34173,6 +34290,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -34551,6 +34669,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -34575,6 +34694,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -34914,6 +35035,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -35259,6 +35381,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -35607,6 +35730,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -35959,6 +36083,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -36331,6 +36456,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -36359,6 +36485,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -36711,6 +36839,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -37089,6 +37218,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -37113,6 +37243,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -37452,6 +37584,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -37820,6 +37953,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -38335,6 +38469,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -38684,6 +38819,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -39020,6 +39156,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -39426,6 +39563,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -39787,6 +39925,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -40152,6 +40291,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -40507,6 +40647,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -40884,6 +41025,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -41239,6 +41381,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -41614,6 +41757,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -41962,6 +42106,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -42314,6 +42459,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -42686,6 +42832,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -42714,6 +42861,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -43066,6 +43215,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -43444,6 +43594,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -43468,6 +43619,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -43807,6 +43960,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -44152,6 +44306,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -44500,6 +44655,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -44852,6 +45008,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -45224,6 +45381,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -45252,6 +45410,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -45604,6 +45764,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -45982,6 +46143,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -46006,6 +46168,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -46345,6 +46509,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -46713,6 +46878,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -47228,6 +47394,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -47577,6 +47744,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -47913,6 +48081,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -48319,6 +48488,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -48680,6 +48850,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -49045,6 +49216,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -49400,6 +49572,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -49777,6 +49950,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -50132,6 +50306,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -50507,6 +50682,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -50855,6 +51031,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -51207,6 +51384,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -51579,6 +51757,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -51607,6 +51786,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -51959,6 +52140,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -52337,6 +52519,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -52361,6 +52544,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -52700,6 +52885,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -53045,6 +53231,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -53393,6 +53580,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -53745,6 +53933,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54117,6 +54306,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54145,6 +54335,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -54497,6 +54689,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54875,6 +55068,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -54899,6 +55093,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -55238,6 +55434,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -55606,6 +55803,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56121,6 +56319,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56470,6 +56669,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -56806,6 +57006,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -57212,6 +57413,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -57573,6 +57775,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -57938,6 +58141,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -58293,6 +58497,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -58670,6 +58875,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -59025,6 +59231,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -59400,6 +59607,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -59748,6 +59956,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -60100,6 +60309,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -60472,6 +60682,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -60500,6 +60711,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -60852,6 +61065,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -61230,6 +61444,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -61254,6 +61469,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -61593,6 +61810,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -61938,6 +62156,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -62286,6 +62505,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -62638,6 +62858,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -63010,6 +63231,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -63038,6 +63260,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -63390,6 +63614,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -63768,6 +63993,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -63792,6 +64018,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -64131,6 +64359,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -64499,6 +64728,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -64992,6 +65222,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -65373,6 +65604,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -65401,6 +65633,8 @@

Method Details

"name": "A String", "serverName": "A String", }, + "processingCall": { # Streaming delta for a server-initiated media processing step. + }, "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool. "queries": [ # Queries for Retrieval information. @@ -65784,6 +66018,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -65808,6 +66043,8 @@

Method Details

}, "serverName": "A String", }, + "processingResult": { # Streaming delta for the result of a server-initiated media processing step. + }, "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -66189,6 +66426,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -66538,6 +66776,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -66886,6 +67125,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -67238,6 +67478,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -67610,6 +67851,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -67638,6 +67880,8 @@

Method Details

"name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, + "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding). + }, "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used. "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool. "queries": [ # Queries for Retrieval information. @@ -67990,6 +68234,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -68368,6 +68613,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. @@ -68392,6 +68638,8 @@

Method Details

}, "serverName": "A String", # The name of the used MCP server. }, + "processingResult": { # The result of a server-initiated media processing step. + }, "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. "isError": True or False, # Whether the retrieval resulted in an error. }, @@ -68731,6 +68979,7 @@

Method Details

"video": { # A video content block. "data": "A String", # The video content. "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. "processingConfig": { "static": { "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactionsHttp.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactionsHttp.html new file mode 100644 index 0000000000..78cfa1a336 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactionsHttp.html @@ -0,0 +1,188 @@ + + + +

Agent Platform API . projects . locations . interactionsHttp

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Cancels an interaction.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Generates a set of responses from the model.

+

+ get(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None)

+

Gets an interaction.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Cancels an interaction.
+
+Args:
+  name: string, Required. The name of the interaction to cancel. Format: `interactions/{interaction}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Generates a set of responses from the model.
+
+Args:
+  parent: string, Required. The parent resource where this interaction will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API only. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [InteractionsService.CreateInteractionHttp].
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Required. The interaction to create.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ +
+ get(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) +
Gets an interaction.
+
+Args:
+  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
+  includeInput: boolean, If true, includes the input in the response.
+  lastEventId: string, If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
+  stream: boolean, If true, streams the interaction events as Server-Sent Events.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html index ccb574481c..bce3aa1127 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html @@ -246,7 +246,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -420,6 +420,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -432,7 +436,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -602,6 +606,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -829,7 +837,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -1003,6 +1011,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1015,7 +1027,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -1185,6 +1197,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1356,7 +1372,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -1530,6 +1546,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1542,7 +1562,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -1712,6 +1732,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1887,7 +1911,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -2061,6 +2085,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2073,7 +2101,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -2243,6 +2271,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index dd209631ed..077def2b56 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -528,6 +528,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -1437,6 +1441,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -2786,6 +2794,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html index 597ac13152..20af59b662 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html @@ -161,6 +161,7 @@

Method Details

"sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated. + "useGkeTd": True or False, # Output only. Whether the source SandboxEnvironment uses the GKE TD pool. }
@@ -196,6 +197,7 @@

Method Details

"sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated. + "useGkeTd": True or False, # Output only. Whether the source SandboxEnvironment uses the GKE TD pool. }, ], }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html index 7c1480922b..8906eb3d04 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -177,6 +177,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "state": "A String", # Output only. The state of the sandbox environment template. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated. + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool. } x__xgafv: string, V1 error format. @@ -322,6 +323,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "state": "A String", # Output only. The state of the sandbox environment template. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated. + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool. }
@@ -410,6 +412,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "state": "A String", # Output only. The state of the sandbox environment template. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated. + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool. }, ], } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html index 9322bb6a9b..f79ce7c523 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html @@ -82,6 +82,9 @@

Instance Methods

authorizeAccess(name, body=None, x__xgafv=None)

Checks whether the caller is authorized to access the sandbox environment. Authorization is performed entirely by the API infrastructure from the `method_policy` below; the handler is a no-op. A successful response means the caller holds `sandboxEnvironments.execute` on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.

+

+ bidiExecute(name, body=None, x__xgafv=None)

+

Executes using a sandbox environment with bidirectional streaming.

close()

Close httplib2 connections.

@@ -137,6 +140,52 @@

Method Details

} +
+ bidiExecute(name, body=None, x__xgafv=None) +
Executes using a sandbox environment with bidirectional streaming.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.
+  "inputs": [ # Required. The inputs to the sandbox environment.
+    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
+      "data": "A String", # Required. The data in the chunk.
+      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
+        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
+          "a_key": "A String",
+        },
+      },
+      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.
+  "outputs": [ # The outputs from the sandbox environment.
+    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
+      "data": "A String", # Required. The data in the chunk.
+      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
+        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
+          "a_key": "A String",
+        },
+      },
+      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
@@ -176,6 +225,7 @@

Method Details

}, "shellEnvironment": { # The shell environment. # Optional. The shell environment for executing shell commands and scripts. }, + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable. }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -331,6 +381,7 @@

Method Details

}, "shellEnvironment": { # The shell environment. # Optional. The shell environment for executing shell commands and scripts. }, + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable. }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -383,6 +434,7 @@

Method Details

}, "shellEnvironment": { # The shell environment. # Optional. The shell environment for executing shell commands and scripts. }, + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable. }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -509,6 +561,7 @@

Method Details

"sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated. + "useGkeTd": True or False, # Output only. Whether the source SandboxEnvironment uses the GKE TD pool. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html index 475c00ce5b..68a146653d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html @@ -118,6 +118,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. @@ -218,6 +221,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. @@ -258,6 +264,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. @@ -304,6 +313,9 @@

Method Details

{ # Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. "agent": "A String", # Required. The name of the agent in Agent Registry that is affected by this policy. "agentIdentity": "A String", # Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + "agentResponseCustomization": { # Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial). # Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request. + "denialMessage": "A String", # Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters. + }, "createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html new file mode 100644 index 0000000000..10aeb841ce --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.events.html @@ -0,0 +1,232 @@ + + + +

Agent Platform API . projects . locations . taskStores . a2aTaskRecords . events

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists TaskEvents for an A2ATaskRecord.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists TaskEvents for an A2ATaskRecord.
+
+Args:
+  parent: string, Required. The resource name of the A2ATaskRecord to list the TaskEvents under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}` (required)
+  filter: string, Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation`
+  pageSize: integer, Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecordEvents call.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for A2ATaskRecordService.ListA2ATaskRecordEvents.
+  "events": [ # List of A2ATaskRecordEvents in the requested page.
+    { # An event that records a single change applied to a task's state.
+      "createTime": "A String", # Output only. The time at which the event was created.
+      "eventData": { # The data describing the change carried by an A2ATaskRecordEvent. Multiple changes can be set in a single event. # Required. The data describing the change carried by this event.
+        "artifactChange": { # An event payload describing a change to one of the task's artifacts. # Optional. A change to one of the task's artifacts.
+          "append": True or False, # Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.
+          "artifact": { # Represents a single artifact produced by a task. # Required. The artifact that was added or updated.
+            "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+            "description": "A String", # Optional. A human-readable description of the artifact.
+            "displayName": "A String", # Optional. The human-readable name of the artifact.
+            "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+              "A String",
+            ],
+            "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+              "a_key": "", # Properties of the object.
+            },
+            "parts": [ # Required. The content parts that make up the artifact.
+              { # A single part of a message or artifact. A part carries exactly one kind of content.
+                "data": "", # Optional. Arbitrary data content.
+                "filename": "A String", # Optional. The name of the file, when the part represents a file.
+                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                  "a_key": "", # Properties of the object.
+                },
+                "raw": "A String", # Optional. Raw binary content.
+                "text": "A String", # Optional. Textual content.
+                "url": "A String", # Optional. A URL pointing to the content.
+              },
+            ],
+          },
+          "lastChunk": True or False, # Optional. Whether this is the last chunk of a streamed artifact.
+        },
+        "historyAppend": { # An event payload that appends a new message to the task history. # Optional. A new message appended to the task history.
+          "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Required. The message to append to the task history.
+            "extensions": [ # Optional. A2A protocol extensions associated with the message.
+              "A String",
+            ],
+            "messageId": "A String", # Required. The unique identifier of the message.
+            "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+              "a_key": "", # Properties of the object.
+            },
+            "parts": [ # Required. The content parts that make up the message.
+              { # A single part of a message or artifact. A part carries exactly one kind of content.
+                "data": "", # Optional. Arbitrary data content.
+                "filename": "A String", # Optional. The name of the file, when the part represents a file.
+                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                  "a_key": "", # Properties of the object.
+                },
+                "raw": "A String", # Optional. Raw binary content.
+                "text": "A String", # Optional. Textual content.
+                "url": "A String", # Optional. A URL pointing to the content.
+              },
+            ],
+            "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+              "A String",
+            ],
+            "role": "A String", # Required. The role of the sender of the message.
+          },
+        },
+        "metadataChange": { # An event payload describing a change to the task-level metadata. # Optional. A change to the task-level metadata.
+          "metadata": { # Required. The updated task metadata after the change. This is a partial update that will be merged with the existing metadata.
+            "a_key": "", # Properties of the object.
+          },
+          "updateMask": "A String", # Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated.
+        },
+        "statusUpdate": { # An event payload that updates the task's state and optional status message. # Optional. An update to the task's state and status message.
+          "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state change.
+            "extensions": [ # Optional. A2A protocol extensions associated with the message.
+              "A String",
+            ],
+            "messageId": "A String", # Required. The unique identifier of the message.
+            "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+              "a_key": "", # Properties of the object.
+            },
+            "parts": [ # Required. The content parts that make up the message.
+              { # A single part of a message or artifact. A part carries exactly one kind of content.
+                "data": "", # Optional. Arbitrary data content.
+                "filename": "A String", # Optional. The name of the file, when the part represents a file.
+                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                  "a_key": "", # Properties of the object.
+                },
+                "raw": "A String", # Optional. Raw binary content.
+                "text": "A String", # Optional. Textual content.
+                "url": "A String", # Optional. A URL pointing to the content.
+              },
+            ],
+            "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+              "A String",
+            ],
+            "role": "A String", # Required. The role of the sender of the message.
+          },
+          "state": "A String", # Required. The new state of the task.
+          "timestamp": "A String", # Optional. The time at which the status change occurred.
+        },
+      },
+      "generation": "A String", # Output only. The generation number of the task after this event is applied.
+      "metadata": { # Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+}
+
+ +
+ 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/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html new file mode 100644 index 0000000000..bfafb4f930 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html @@ -0,0 +1,850 @@ + + + +

Agent Platform API . projects . locations . taskStores . a2aTaskRecords

+

Instance Methods

+

+ events() +

+

Returns the events Resource.

+ +

+ appendEvents(name, body=None, x__xgafv=None)

+

Appends A2ATaskRecordEvents to an A2ATaskRecord.

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, a2aTaskRecordId=None, body=None, x__xgafv=None)

+

Creates an A2ATaskRecord.

+

+ delete(name, x__xgafv=None)

+

Deletes an A2ATaskRecord.

+

+ get(name, view=None, x__xgafv=None)

+

Gets an A2ATaskRecord.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists A2ATaskRecords in a TaskStore.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ appendEvents(name, body=None, x__xgafv=None) +
Appends A2ATaskRecordEvents to an A2ATaskRecord.
+
+Args:
+  name: string, Required. The resource name of the A2ATaskRecord to append events to. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for A2ATaskRecordService.AppendA2ATaskRecordEvents.
+  "events": [ # Required. The events to append to the task.
+    { # An event that records a single change applied to a task's state.
+      "createTime": "A String", # Output only. The time at which the event was created.
+      "eventData": { # The data describing the change carried by an A2ATaskRecordEvent. Multiple changes can be set in a single event. # Required. The data describing the change carried by this event.
+        "artifactChange": { # An event payload describing a change to one of the task's artifacts. # Optional. A change to one of the task's artifacts.
+          "append": True or False, # Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.
+          "artifact": { # Represents a single artifact produced by a task. # Required. The artifact that was added or updated.
+            "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+            "description": "A String", # Optional. A human-readable description of the artifact.
+            "displayName": "A String", # Optional. The human-readable name of the artifact.
+            "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+              "A String",
+            ],
+            "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+              "a_key": "", # Properties of the object.
+            },
+            "parts": [ # Required. The content parts that make up the artifact.
+              { # A single part of a message or artifact. A part carries exactly one kind of content.
+                "data": "", # Optional. Arbitrary data content.
+                "filename": "A String", # Optional. The name of the file, when the part represents a file.
+                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                  "a_key": "", # Properties of the object.
+                },
+                "raw": "A String", # Optional. Raw binary content.
+                "text": "A String", # Optional. Textual content.
+                "url": "A String", # Optional. A URL pointing to the content.
+              },
+            ],
+          },
+          "lastChunk": True or False, # Optional. Whether this is the last chunk of a streamed artifact.
+        },
+        "historyAppend": { # An event payload that appends a new message to the task history. # Optional. A new message appended to the task history.
+          "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Required. The message to append to the task history.
+            "extensions": [ # Optional. A2A protocol extensions associated with the message.
+              "A String",
+            ],
+            "messageId": "A String", # Required. The unique identifier of the message.
+            "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+              "a_key": "", # Properties of the object.
+            },
+            "parts": [ # Required. The content parts that make up the message.
+              { # A single part of a message or artifact. A part carries exactly one kind of content.
+                "data": "", # Optional. Arbitrary data content.
+                "filename": "A String", # Optional. The name of the file, when the part represents a file.
+                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                  "a_key": "", # Properties of the object.
+                },
+                "raw": "A String", # Optional. Raw binary content.
+                "text": "A String", # Optional. Textual content.
+                "url": "A String", # Optional. A URL pointing to the content.
+              },
+            ],
+            "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+              "A String",
+            ],
+            "role": "A String", # Required. The role of the sender of the message.
+          },
+        },
+        "metadataChange": { # An event payload describing a change to the task-level metadata. # Optional. A change to the task-level metadata.
+          "metadata": { # Required. The updated task metadata after the change. This is a partial update that will be merged with the existing metadata.
+            "a_key": "", # Properties of the object.
+          },
+          "updateMask": "A String", # Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated.
+        },
+        "statusUpdate": { # An event payload that updates the task's state and optional status message. # Optional. An update to the task's state and status message.
+          "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state change.
+            "extensions": [ # Optional. A2A protocol extensions associated with the message.
+              "A String",
+            ],
+            "messageId": "A String", # Required. The unique identifier of the message.
+            "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+              "a_key": "", # Properties of the object.
+            },
+            "parts": [ # Required. The content parts that make up the message.
+              { # A single part of a message or artifact. A part carries exactly one kind of content.
+                "data": "", # Optional. Arbitrary data content.
+                "filename": "A String", # Optional. The name of the file, when the part represents a file.
+                "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+                "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                  "a_key": "", # Properties of the object.
+                },
+                "raw": "A String", # Optional. Raw binary content.
+                "text": "A String", # Optional. Textual content.
+                "url": "A String", # Optional. A URL pointing to the content.
+              },
+            ],
+            "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+              "A String",
+            ],
+            "role": "A String", # Required. The role of the sender of the message.
+          },
+          "state": "A String", # Required. The new state of the task.
+          "timestamp": "A String", # Optional. The time at which the status change occurred.
+        },
+      },
+      "generation": "A String", # Output only. The generation number of the task after this event is applied.
+      "metadata": { # Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "generation": "A String", # Required. The current task generation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for A2ATaskRecordService.AppendA2ATaskRecordEvents.
+  "generation": "A String", # Task generation matching the last event
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, a2aTaskRecordId=None, body=None, x__xgafv=None) +
Creates an A2ATaskRecord.
+
+Args:
+  parent: string, Required. The resource name of the TaskStore to create the A2ATaskRecord under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.
+  "appId": "A String", # Optional. Agent application which created the task.
+  "artifacts": [ # Output only. The artifacts produced by the task.
+    { # Represents a single artifact produced by a task.
+      "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+      "description": "A String", # Optional. A human-readable description of the artifact.
+      "displayName": "A String", # Optional. The human-readable name of the artifact.
+      "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+        "A String",
+      ],
+      "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the artifact.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+    },
+  ],
+  "contextId": "A String", # Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).
+  "createTime": "A String", # Output only. The creation timestamp of the task.
+  "deleteTime": "A String", # Output only. The deletion timestamp of the task.
+  "expireTime": "A String", # Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.
+  "generation": "A String", # Output only. The task generation number.
+  "history": [ # Output only. The history of the task messages.
+    { # Represents a single message in a conversation, compliant with the A2A specification.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+  ],
+  "metadata": { # Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`
+  "purgeTime": "A String", # Output only. The purge timestamp of the task.
+  "serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.
+    "a_key": "", # Properties of the object.
+  },
+  "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp.
+    "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+    "state": "A String", # Output only. The current state of the task.
+    "timestamp": "A String", # Output only. The time at which the state was set.
+  },
+  "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]
+  "updateTime": "A String", # Output only. The last update timestamp of the task.
+  "userId": "A String", # Optional. Task owner user ID.
+}
+
+  a2aTaskRecordId: string, Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.
+  "appId": "A String", # Optional. Agent application which created the task.
+  "artifacts": [ # Output only. The artifacts produced by the task.
+    { # Represents a single artifact produced by a task.
+      "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+      "description": "A String", # Optional. A human-readable description of the artifact.
+      "displayName": "A String", # Optional. The human-readable name of the artifact.
+      "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+        "A String",
+      ],
+      "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the artifact.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+    },
+  ],
+  "contextId": "A String", # Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).
+  "createTime": "A String", # Output only. The creation timestamp of the task.
+  "deleteTime": "A String", # Output only. The deletion timestamp of the task.
+  "expireTime": "A String", # Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.
+  "generation": "A String", # Output only. The task generation number.
+  "history": [ # Output only. The history of the task messages.
+    { # Represents a single message in a conversation, compliant with the A2A specification.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+  ],
+  "metadata": { # Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`
+  "purgeTime": "A String", # Output only. The purge timestamp of the task.
+  "serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.
+    "a_key": "", # Properties of the object.
+  },
+  "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp.
+    "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+    "state": "A String", # Output only. The current state of the task.
+    "timestamp": "A String", # Output only. The time at which the state was set.
+  },
+  "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]
+  "updateTime": "A String", # Output only. The last update timestamp of the task.
+  "userId": "A String", # Optional. Task owner user ID.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an A2ATaskRecord.
+
+Args:
+  name: string, Required. The resource name of the A2ATaskRecord to delete. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.
+  "appId": "A String", # Optional. Agent application which created the task.
+  "artifacts": [ # Output only. The artifacts produced by the task.
+    { # Represents a single artifact produced by a task.
+      "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+      "description": "A String", # Optional. A human-readable description of the artifact.
+      "displayName": "A String", # Optional. The human-readable name of the artifact.
+      "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+        "A String",
+      ],
+      "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the artifact.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+    },
+  ],
+  "contextId": "A String", # Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).
+  "createTime": "A String", # Output only. The creation timestamp of the task.
+  "deleteTime": "A String", # Output only. The deletion timestamp of the task.
+  "expireTime": "A String", # Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.
+  "generation": "A String", # Output only. The task generation number.
+  "history": [ # Output only. The history of the task messages.
+    { # Represents a single message in a conversation, compliant with the A2A specification.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+  ],
+  "metadata": { # Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`
+  "purgeTime": "A String", # Output only. The purge timestamp of the task.
+  "serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.
+    "a_key": "", # Properties of the object.
+  },
+  "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp.
+    "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+    "state": "A String", # Output only. The current state of the task.
+    "timestamp": "A String", # Output only. The time at which the state was set.
+  },
+  "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]
+  "updateTime": "A String", # Output only. The last update timestamp of the task.
+  "userId": "A String", # Optional. Task owner user ID.
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets an A2ATaskRecord.
+
+Args:
+  name: string, Required. The resource name of the A2ATaskRecord. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}` (required)
+  view: string, Optional. The view of the A2ATaskRecord to return.
+    Allowed values
+      A2A_TASK_RECORD_VIEW_UNSPECIFIED - Task view unspecified.
+      A2A_TASK_RECORD_VIEW_BASIC - Task header only (status, metadata, timestamps)
+      A2A_TASK_RECORD_VIEW_FULL - Full materialized state (artifacts + history)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.
+  "appId": "A String", # Optional. Agent application which created the task.
+  "artifacts": [ # Output only. The artifacts produced by the task.
+    { # Represents a single artifact produced by a task.
+      "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+      "description": "A String", # Optional. A human-readable description of the artifact.
+      "displayName": "A String", # Optional. The human-readable name of the artifact.
+      "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+        "A String",
+      ],
+      "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the artifact.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+    },
+  ],
+  "contextId": "A String", # Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).
+  "createTime": "A String", # Output only. The creation timestamp of the task.
+  "deleteTime": "A String", # Output only. The deletion timestamp of the task.
+  "expireTime": "A String", # Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.
+  "generation": "A String", # Output only. The task generation number.
+  "history": [ # Output only. The history of the task messages.
+    { # Represents a single message in a conversation, compliant with the A2A specification.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+  ],
+  "metadata": { # Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures.
+    "a_key": "", # Properties of the object.
+  },
+  "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`
+  "purgeTime": "A String", # Output only. The purge timestamp of the task.
+  "serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.
+    "a_key": "", # Properties of the object.
+  },
+  "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp.
+    "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state.
+      "extensions": [ # Optional. A2A protocol extensions associated with the message.
+        "A String",
+      ],
+      "messageId": "A String", # Required. The unique identifier of the message.
+      "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+        "a_key": "", # Properties of the object.
+      },
+      "parts": [ # Required. The content parts that make up the message.
+        { # A single part of a message or artifact. A part carries exactly one kind of content.
+          "data": "", # Optional. Arbitrary data content.
+          "filename": "A String", # Optional. The name of the file, when the part represents a file.
+          "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+          "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "raw": "A String", # Optional. Raw binary content.
+          "text": "A String", # Optional. Textual content.
+          "url": "A String", # Optional. A URL pointing to the content.
+        },
+      ],
+      "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+        "A String",
+      ],
+      "role": "A String", # Required. The role of the sender of the message.
+    },
+    "state": "A String", # Output only. The current state of the task.
+    "timestamp": "A String", # Output only. The time at which the state was set.
+  },
+  "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]
+  "updateTime": "A String", # Output only. The last update timestamp of the task.
+  "userId": "A String", # Optional. Task owner user ID.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists A2ATaskRecords in a TaskStore.
+
+Args:
+  parent: string, Required. The resource name of the TaskStore to list the A2ATaskRecords under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `status.state` Example: `context_id="abc"`, `status.state="WORKING"`.
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
+  pageSize: integer, Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecords call.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for A2ATaskRecordService.ListA2ATaskRecords.
+  "a2aTaskRecords": [ # List of A2ATaskRecords in the requested page.
+    { # An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.
+      "appId": "A String", # Optional. Agent application which created the task.
+      "artifacts": [ # Output only. The artifacts produced by the task.
+        { # Represents a single artifact produced by a task.
+          "artifactId": "A String", # Required. The unique identifier of the artifact within the task.
+          "description": "A String", # Optional. A human-readable description of the artifact.
+          "displayName": "A String", # Optional. The human-readable name of the artifact.
+          "extensions": [ # Optional. A2A protocol extensions associated with the artifact.
+            "A String",
+          ],
+          "metadata": { # Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "parts": [ # Required. The content parts that make up the artifact.
+            { # A single part of a message or artifact. A part carries exactly one kind of content.
+              "data": "", # Optional. Arbitrary data content.
+              "filename": "A String", # Optional. The name of the file, when the part represents a file.
+              "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+              "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                "a_key": "", # Properties of the object.
+              },
+              "raw": "A String", # Optional. Raw binary content.
+              "text": "A String", # Optional. Textual content.
+              "url": "A String", # Optional. A URL pointing to the content.
+            },
+          ],
+        },
+      ],
+      "contextId": "A String", # Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).
+      "createTime": "A String", # Output only. The creation timestamp of the task.
+      "deleteTime": "A String", # Output only. The deletion timestamp of the task.
+      "expireTime": "A String", # Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.
+      "generation": "A String", # Output only. The task generation number.
+      "history": [ # Output only. The history of the task messages.
+        { # Represents a single message in a conversation, compliant with the A2A specification.
+          "extensions": [ # Optional. A2A protocol extensions associated with the message.
+            "A String",
+          ],
+          "messageId": "A String", # Required. The unique identifier of the message.
+          "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "parts": [ # Required. The content parts that make up the message.
+            { # A single part of a message or artifact. A part carries exactly one kind of content.
+              "data": "", # Optional. Arbitrary data content.
+              "filename": "A String", # Optional. The name of the file, when the part represents a file.
+              "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+              "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                "a_key": "", # Properties of the object.
+              },
+              "raw": "A String", # Optional. Raw binary content.
+              "text": "A String", # Optional. Textual content.
+              "url": "A String", # Optional. A URL pointing to the content.
+            },
+          ],
+          "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+            "A String",
+          ],
+          "role": "A String", # Required. The role of the sender of the message.
+        },
+      ],
+      "metadata": { # Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures.
+        "a_key": "", # Properties of the object.
+      },
+      "name": "A String", # Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`
+      "purgeTime": "A String", # Output only. The purge timestamp of the task.
+      "serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.
+        "a_key": "", # Properties of the object.
+      },
+      "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp.
+        "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state.
+          "extensions": [ # Optional. A2A protocol extensions associated with the message.
+            "A String",
+          ],
+          "messageId": "A String", # Required. The unique identifier of the message.
+          "metadata": { # Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.
+            "a_key": "", # Properties of the object.
+          },
+          "parts": [ # Required. The content parts that make up the message.
+            { # A single part of a message or artifact. A part carries exactly one kind of content.
+              "data": "", # Optional. Arbitrary data content.
+              "filename": "A String", # Optional. The name of the file, when the part represents a file.
+              "mediaType": "A String", # Optional. The IANA media type of the content, e.g. "text/plain" or "image/png".
+              "metadata": { # Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.
+                "a_key": "", # Properties of the object.
+              },
+              "raw": "A String", # Optional. Raw binary content.
+              "text": "A String", # Optional. Textual content.
+              "url": "A String", # Optional. A URL pointing to the content.
+            },
+          ],
+          "referenceTaskIds": [ # Optional. The IDs of other tasks referenced by this message.
+            "A String",
+          ],
+          "role": "A String", # Required. The role of the sender of the message.
+        },
+        "state": "A String", # Output only. The current state of the task.
+        "timestamp": "A String", # Output only. The time at which the state was set.
+      },
+      "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]
+      "updateTime": "A String", # Output only. The last update timestamp of the task.
+      "userId": "A String", # Optional. Task owner user ID.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as A2ATaskRecordService.ListA2ATaskRecordsRequest.page_token to retrieve the next page. Absence of this field indicates 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/aiplatform_v1beta1.projects.locations.taskStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.html new file mode 100644 index 0000000000..7660321eed --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.html @@ -0,0 +1,96 @@ + + + +

Agent Platform API . projects . locations . taskStores

+

Instance Methods

+

+ a2aTaskRecords() +

+

Returns the a2aTaskRecords Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Platform API . projects . locations . taskStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

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

+

Method Details

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

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -694,6 +698,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -912,6 +920,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1083,6 +1095,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -1099,7 +1115,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -1273,6 +1289,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1285,7 +1305,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -1455,6 +1475,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3524,6 +3548,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3751,6 +3779,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3969,6 +4001,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4140,6 +4176,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -4156,7 +4196,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -4330,6 +4370,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4342,7 +4386,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -4512,6 +4556,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6588,6 +6636,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6815,6 +6867,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7033,6 +7089,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7204,6 +7264,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -7220,7 +7284,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -7394,6 +7458,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -7406,7 +7474,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -7576,6 +7644,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -9658,6 +9730,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -9885,6 +9961,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10103,6 +10183,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10274,6 +10358,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -10290,7 +10378,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -10464,6 +10552,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -10476,7 +10568,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -10646,6 +10738,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -13002,6 +13098,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -13229,6 +13329,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -13447,6 +13551,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -13618,6 +13726,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "metrics": [ # Required. The metrics used for evaluation. { # The metric used for running evaluations. @@ -13634,7 +13746,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -13808,6 +13920,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -13820,7 +13936,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -13990,6 +14106,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -15942,6 +16062,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -16672,6 +16796,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index cec06055d7..76f9e1bb9c 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -508,6 +508,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", @@ -1171,6 +1175,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", @@ -3438,6 +3446,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html index cca3ef023c..9875646830 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html @@ -161,6 +161,7 @@

Method Details

"sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated. + "useGkeTd": True or False, # Output only. Whether the source SandboxEnvironment uses the GKE TD pool. }
@@ -196,6 +197,7 @@

Method Details

"sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated. + "useGkeTd": True or False, # Output only. Whether the source SandboxEnvironment uses the GKE TD pool. }, ], } diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html index 778eaac405..6d30eeba8a 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -177,6 +177,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "state": "A String", # Output only. The state of the sandbox environment template. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated. + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool. } x__xgafv: string, V1 error format. @@ -322,6 +323,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "state": "A String", # Output only. The state of the sandbox environment template. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated. + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool. } @@ -410,6 +412,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "state": "A String", # Output only. The state of the sandbox environment template. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated. + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool. }, ], } diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html index 2915fb9b0c..543347e5d0 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html @@ -82,6 +82,9 @@

Instance Methods

authorizeAccess(name, body=None, x__xgafv=None)

Checks whether the caller is authorized to access the sandbox environment. Authorization is performed entirely by the API infrastructure from the `method_policy` below; the handler is a no-op. A successful response means the caller holds `sandboxEnvironments.execute` on the named sandbox. Used by the sandbox data-plane proxy, which forwards the caller's credential and proxies traffic only on success.

+

+ bidiExecute(name, body=None, x__xgafv=None)

+

Executes using a sandbox environment with bidirectional streaming.

close()

Close httplib2 connections.

@@ -137,6 +140,52 @@

Method Details

} +
+ bidiExecute(name, body=None, x__xgafv=None) +
Executes using a sandbox environment with bidirectional streaming.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.
+  "inputs": [ # Required. The inputs to the sandbox environment.
+    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
+      "data": "A String", # Required. The data in the chunk.
+      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
+        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
+          "a_key": "A String",
+        },
+      },
+      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.
+  "outputs": [ # The outputs from the sandbox environment.
+    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
+      "data": "A String", # Required. The data in the chunk.
+      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
+        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
+          "a_key": "A String",
+        },
+      },
+      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
@@ -176,6 +225,7 @@

Method Details

}, "shellEnvironment": { # The shell environment. # Optional. The shell environment for executing shell commands and scripts. }, + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable. }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -331,6 +381,7 @@

Method Details

}, "shellEnvironment": { # The shell environment. # Optional. The shell environment for executing shell commands and scripts. }, + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable. }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -383,6 +434,7 @@

Method Details

}, "shellEnvironment": { # The shell environment. # Optional. The shell environment for executing shell commands and scripts. }, + "useGkeTd": True or False, # Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable. }, "state": "A String", # Output only. The runtime state of the SandboxEnvironment. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. @@ -509,6 +561,7 @@

Method Details

"sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from. "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated. + "useGkeTd": True or False, # Output only. Whether the source SandboxEnvironment uses the GKE TD pool. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/aiplatform_v1beta1.taskStores.html b/docs/dyn/aiplatform_v1beta1.taskStores.html new file mode 100644 index 0000000000..ab86c22e03 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.taskStores.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . taskStores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Agent Platform API . taskStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

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

+

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

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

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

+

Method Details

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

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -295,7 +299,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -469,6 +473,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -481,7 +489,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -651,6 +659,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -914,6 +926,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3490,7 +3506,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -3664,6 +3680,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3676,7 +3696,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -3846,6 +3866,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3916,7 +3940,7 @@

Method Details

"type": "A String", # Required. The type of the computation based metric. }, "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED. "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function. }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. @@ -4090,6 +4114,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -4102,7 +4130,7 @@

Method Details

}, "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. - "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used. + "codeExecutionRegion": "A String", # Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used. "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation }, }, @@ -4272,6 +4300,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -5740,6 +5772,10 @@

Method Details

}, "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + "translationConfig": { # Config for translation features. # Optional. Config for translation. + "echoTargetLanguage": True or False, # Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language. + "targetLanguageCode": "A String", # Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). + }, }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.html b/docs/dyn/bigqueryreservation_v1.projects.locations.html index 7ab440faca..78573ad61e 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.html @@ -175,7 +175,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -232,7 +232,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html index 4b41147654..6ad5a34530 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservations.assignments.html @@ -131,7 +131,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -160,7 +160,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -265,7 +265,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -325,7 +325,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -355,7 +355,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. @@ -384,7 +384,7 @@

Method Details

"jobType": "A String", # Optional. Which type of jobs will use the reservation. "name": "A String", # Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. "precedence": "A String", # Optional. Specifies the priority precedence for this assignment. Used to resolve ambiguity when multiple assignments match a single job. Higher numerical values represent higher priority (e.g., 20 is higher than 10). If unspecified, it defaults to 0. Multiple assignments can share the same precedence, but it is recommended to use unique precedence values for assignments within the same assignee scope. - "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users. + "principal": "A String", # Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users. "schedulingPolicy": { # The scheduling policy controls how a reservation's resources are distributed. # Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. "concurrency": "A String", # Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. "maxSlots": "A String", # Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 31423f3ab7..8137e2fe46 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -361,7 +361,7 @@

Method Details

"type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space. } - requestId: string, Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. + requestId: string, Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1435,7 +1435,7 @@

Method Details

"state": "A String", # Output only. State of the membership. }, ], - "requestId": "A String", # Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. + "requestId": "A String", # Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error. "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Required. The `Space.spaceType` field is required. To create a space, set `Space.spaceType` to `SPACE` and set `Space.displayName`. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. To create a group chat, set `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation between a human and the calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space is returned instead of creating a new space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index b26604fc37..d96c8daf93 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -3182,7 +3182,7 @@

Method Details

MESSAGE_REPLY_OPTION_UNSPECIFIED - Default. Starts a new thread. Using this option ignores any thread ID or `thread_key` that's included. REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD - Creates the message as a reply to the thread specified by thread ID or `thread_key`. If it fails, the message starts a new thread instead. REPLY_MESSAGE_OR_FAIL - Creates the message as a reply to the thread specified by thread ID or `thread_key`. If a new `thread_key` is used, a new thread is created. If the message creation fails, a `NOT_FOUND` error is returned instead. - requestId: string, Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. + requestId: string, Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call `GetMessage`. - Reusing an existing request ID with a different authenticated user results in an error. threadKey: string, Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.html index a03e03e69a..fae185e4e2 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.html @@ -92,7 +92,7 @@

Instance Methods

Create a new KeyRing in a given Project and Location.

delete(name, x__xgafv=None)

-

Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone. Note: the key ring and its metadata will be remembered by KeyManagementService to prevent re-use of the key ring's resource name.

+

Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone.

get(name, x__xgafv=None)

Returns metadata for a given KeyRing.

@@ -148,7 +148,7 @@

Method Details

delete(name, x__xgafv=None) -
Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone. Note: the key ring and its metadata will be remembered by KeyManagementService to prevent re-use of the key ring's resource name.
+  
Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone.
 
 Args:
   name: string, Required. The name of the KeyRing to delete. (required)
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
index ec87cb676f..fd9530e15a 100644
--- a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
+++ b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
@@ -197,7 +197,7 @@ 

Method Details

Args: parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required) - filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321` + filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` - `partner_link_metadata.implicit_accounts.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321` pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/developerknowledge_v1.documents.html b/docs/dyn/developerknowledge_v1.documents.html index 5926d8cfa8..271f807dde 100644 --- a/docs/dyn/developerknowledge_v1.documents.html +++ b/docs/dyn/developerknowledge_v1.documents.html @@ -120,7 +120,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }, ], @@ -160,7 +160,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }
@@ -195,7 +195,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }, "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. diff --git a/docs/dyn/developerknowledge_v1.v1.html b/docs/dyn/developerknowledge_v1.v1.html index 616a5c7ad5..24923b553f 100644 --- a/docs/dyn/developerknowledge_v1.v1.html +++ b/docs/dyn/developerknowledge_v1.v1.html @@ -129,7 +129,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }, "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. diff --git a/docs/dyn/developerknowledge_v1alpha.documents.html b/docs/dyn/developerknowledge_v1alpha.documents.html index 92a0c51cb2..00e6532514 100644 --- a/docs/dyn/developerknowledge_v1alpha.documents.html +++ b/docs/dyn/developerknowledge_v1alpha.documents.html @@ -120,7 +120,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }, ], @@ -160,7 +160,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }
@@ -195,7 +195,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }, "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. diff --git a/docs/dyn/developerknowledge_v1alpha.v1alpha.html b/docs/dyn/developerknowledge_v1alpha.v1alpha.html index beee8247ec..c448bc6d8a 100644 --- a/docs/dyn/developerknowledge_v1alpha.v1alpha.html +++ b/docs/dyn/developerknowledge_v1alpha.v1alpha.html @@ -129,7 +129,7 @@

Method Details

"name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` "title": "A String", # Output only. Provides the title of the document. "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated. - "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`. + "uri": "A String", # Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`. "view": "A String", # Output only. Specifies the DocumentView of the document. }, "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time. diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html index 877968bcc5..2890890dad 100644 --- a/docs/dyn/displayvideo_v2.advertisers.html +++ b/docs/dyn/displayvideo_v2.advertisers.html @@ -485,7 +485,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -565,7 +565,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -798,7 +798,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -878,7 +878,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1266,7 +1266,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1346,7 +1346,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 0722ab4c00..61de663f5a 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -245,7 +245,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -325,7 +325,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -602,7 +602,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -682,7 +682,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 3787274246..354e46c2f8 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -276,7 +276,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -356,7 +356,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -574,7 +574,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -654,7 +654,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1005,7 +1005,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1085,7 +1085,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1369,7 +1369,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1449,7 +1449,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index 8b5930245c..af29e78b5d 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -275,7 +275,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -355,7 +355,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -573,7 +573,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -653,7 +653,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1002,7 +1002,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1082,7 +1082,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1365,7 +1365,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1445,7 +1445,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index b511b7622d..f17282b828 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -237,7 +237,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -317,7 +317,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index 5ab2232b9c..569406275b 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -276,7 +276,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -356,7 +356,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -640,7 +640,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -720,7 +720,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html index ad91edc1d3..46bd29700d 100644 --- a/docs/dyn/displayvideo_v2.partners.html +++ b/docs/dyn/displayvideo_v2.partners.html @@ -234,7 +234,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -314,7 +314,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -547,7 +547,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -627,7 +627,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index 9f2e9e4aba..51ce499dbb 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -275,7 +275,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -355,7 +355,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -573,7 +573,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -653,7 +653,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1002,7 +1002,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1082,7 +1082,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1365,7 +1365,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1445,7 +1445,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 7ef8aca39b..5978e2dd4a 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -110,7 +110,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A single ad associated with an ad group. +{ # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -623,7 +623,7 @@

Method Details

Returns: An object of the form: - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1163,7 +1163,7 @@

Method Details

Returns: An object of the form: - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1689,7 +1689,7 @@

Method Details

{ "adGroupAds": [ # The list of ads. This list will be absent if empty. - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2222,7 +2222,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A single ad associated with an ad group. +{ # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2736,7 +2736,7 @@

Method Details

Returns: An object of the form: - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 5d88b2f1c5..f1933e25b8 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -265,7 +265,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -345,7 +345,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -663,7 +663,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -743,7 +743,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 69c308a2bb..1b6aa9df79 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -300,7 +300,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -380,7 +380,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -641,7 +641,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -721,7 +721,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1117,7 +1117,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1197,7 +1197,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1525,7 +1525,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1605,7 +1605,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index 53ffc8d108..9f0e5cea4c 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -509,7 +509,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -589,7 +589,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -865,7 +865,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -945,7 +945,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1382,7 +1382,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1462,7 +1462,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html index ba3c55e792..320398680c 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -268,7 +268,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -348,7 +348,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -668,7 +668,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -748,7 +748,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 4d0e00dbbe..f1c7d4fba3 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -300,7 +300,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -380,7 +380,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -641,7 +641,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -721,7 +721,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1117,7 +1117,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1197,7 +1197,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1525,7 +1525,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1605,7 +1605,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index cde5c6d678..c2fa926546 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -299,7 +299,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -379,7 +379,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -640,7 +640,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -720,7 +720,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1114,7 +1114,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1194,7 +1194,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1521,7 +1521,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1601,7 +1601,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.partners.html b/docs/dyn/displayvideo_v3.partners.html index 0038ed447a..0a666febf1 100644 --- a/docs/dyn/displayvideo_v3.partners.html +++ b/docs/dyn/displayvideo_v3.partners.html @@ -257,7 +257,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -337,7 +337,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -613,7 +613,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -693,7 +693,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index 9dafb0eb32..edf125ff47 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -299,7 +299,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -379,7 +379,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -640,7 +640,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -720,7 +720,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1114,7 +1114,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1194,7 +1194,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1521,7 +1521,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1601,7 +1601,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index 85cbb9567a..45422d9716 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -110,7 +110,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A single ad associated with an ad group. +{ # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -623,7 +623,7 @@

Method Details

Returns: An object of the form: - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1163,7 +1163,7 @@

Method Details

Returns: An object of the form: - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -1689,7 +1689,7 @@

Method Details

{ "adGroupAds": [ # The list of ads. This list will be absent if empty. - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2222,7 +2222,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A single ad associated with an ad group. +{ # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. @@ -2736,7 +2736,7 @@

Method Details

Returns: An object of the form: - { # A single ad associated with an ad group. + { # LINT: LEGACY_NAMES A single ad associated with an ad group. "adGroupAdId": "A String", # Output only. The unique ID of the ad. Assigned by the system. "adGroupId": "A String", # Required. Immutable. The unique ID of the ad group that the ad belongs to. "adPolicy": { # A single ad policy associated with an ad group ad. # Output only. The policy approval status of the ad. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index bced608c11..0a67b1c8c7 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -270,7 +270,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -350,7 +350,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -668,7 +668,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -748,7 +748,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index a78d5659f7..78933782d9 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -300,7 +300,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -380,7 +380,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -641,7 +641,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -721,7 +721,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1117,7 +1117,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1197,7 +1197,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1525,7 +1525,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1605,7 +1605,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.advertisers.html b/docs/dyn/displayvideo_v4.advertisers.html index ea58ca039b..33cd68c4e0 100644 --- a/docs/dyn/displayvideo_v4.advertisers.html +++ b/docs/dyn/displayvideo_v4.advertisers.html @@ -519,7 +519,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -599,7 +599,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -875,7 +875,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -955,7 +955,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1392,7 +1392,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1472,7 +1472,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index e257f4a3bc..9e8f16b678 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -273,7 +273,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -353,7 +353,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -673,7 +673,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -753,7 +753,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 14680660ae..0998488441 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -300,7 +300,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -380,7 +380,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -641,7 +641,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -721,7 +721,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1117,7 +1117,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1197,7 +1197,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1525,7 +1525,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1605,7 +1605,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html index 8c34340a8b..90d8f6c557 100644 --- a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html @@ -299,7 +299,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -379,7 +379,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -640,7 +640,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -720,7 +720,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1114,7 +1114,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1194,7 +1194,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1521,7 +1521,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1601,7 +1601,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.partners.html b/docs/dyn/displayvideo_v4.partners.html index 9e40129a3f..3c0f7d1ec6 100644 --- a/docs/dyn/displayvideo_v4.partners.html +++ b/docs/dyn/displayvideo_v4.partners.html @@ -257,7 +257,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -337,7 +337,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -613,7 +613,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -693,7 +693,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html index 0d821547e2..efe719ac03 100644 --- a/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html @@ -299,7 +299,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -379,7 +379,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -640,7 +640,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -720,7 +720,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1114,7 +1114,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1194,7 +1194,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. @@ -1521,7 +1521,7 @@

Method Details

"youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items. }, "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. - "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. + "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.** }, "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. "environment": "A String", # Required. The serving environment. @@ -1601,7 +1601,7 @@

Method Details

"regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. }, "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. - "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.** }, "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. "sessionPosition": "A String", # The position where the ad will show in a session. diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index 87ec2a0bf3..6825d53428 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -39715,7 +39715,7 @@

Method Details

Args: documentId: string, The ID of the document to retrieve. (required) - includeTabsContent: boolean, Whether to populate the Document.tabs field instead of the text content fields like `body` and `documentStyle` on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty. + includeTabsContent: boolean, Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content populates in the `Document.tabs` field instead of the text content fields in `Document`. - When `false`: The content of the document's first tab populates the content fields in `Document` excluding `Document.tabs`. If a document has only one tab, then that tab is used to populate the document content. `Document.tabs` will be empty. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`. suggestionsViewMode: string, The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used. Allowed values DEFAULT_FOR_CURRENT_ACCESS - The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode. diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html index f4b4d27513..cd023fcf55 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html @@ -123,7 +123,7 @@

Method Details

"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. - "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field. }, "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. @@ -197,7 +197,7 @@

Method Details

"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. - "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field. }, "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. @@ -278,7 +278,7 @@

Method Details

"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. - "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field. }, "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html index 92318da4ff..2e73d5cd11 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html @@ -117,7 +117,7 @@

Method Details

"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. - "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field. }, "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. @@ -218,7 +218,7 @@

Method Details

"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. - "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field. }, "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. @@ -278,7 +278,7 @@

Method Details

"order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. "searchConfig": { # The configuration for how to index a field for search. # Indicates that this field supports search operations. "geoSpec": { # The specification for how to build a geo search index for a field. # Optional. The specification for building a geo search index for a field. - "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. + "geoJsonIndexingDisabled": True or False, # Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field. }, "textSpec": { # The specification for how to build a text search index for a field. # Optional. The specification for building a text search index for a field. "indexSpecs": [ # Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways. diff --git a/googleapiclient/discovery_cache/documents/agenciesandbrands.v1.json b/googleapiclient/discovery_cache/documents/agenciesandbrands.v1.json index 6b9641fc35..62c24cb6a8 100644 --- a/googleapiclient/discovery_cache/documents/agenciesandbrands.v1.json +++ b/googleapiclient/discovery_cache/documents/agenciesandbrands.v1.json @@ -377,7 +377,7 @@ } } }, -"revision": "20260828", +"revision": "20260901", "rootUrl": "https://agenciesandbrands.googleapis.com/", "schemas": { "Date": { @@ -683,7 +683,7 @@ "Clicks.", "CPC.", "CPM.", -"Curator fee.", +"Curator fee. This will be redacted to 0.00 if the package's visibility is set to non-disclosed. Use the PACKAGE_FEE_VISIBILITY dimension to check if the package's fee is disclosed.", "Discount amount in media planner currency.", "Discount rate in media planner currency.", "Engaged views.", @@ -1104,7 +1104,7 @@ "Clicks.", "CPC.", "CPM.", -"Curator fee.", +"Curator fee. This will be redacted to 0.00 if the package's visibility is set to non-disclosed. Use the PACKAGE_FEE_VISIBILITY dimension to check if the package's fee is disclosed.", "Discount amount in media planner currency.", "Discount rate in media planner currency.", "Engaged views.", diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json index 88a5370294..99473a8494 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json @@ -1264,7 +1264,7 @@ ], "parameters": { "filter": { -"description": "Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.", +"description": "Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.", "location": "query", "type": "string" }, @@ -1355,7 +1355,7 @@ ], "parameters": { "filter": { -"description": "Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.", +"description": "Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.", "location": "query", "type": "string" }, @@ -1378,7 +1378,7 @@ "type": "string" }, "searchString": { -"description": "Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |----------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | publisher | No | Yes | Yes | Excluded | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | | frontmatter.metadata. | No | Yes | No | Excluded | | attributes.. | No | Yes | No | Excluded | Examples: * `skillId=\"urn:skill:projects-1234:locations:global:private-important-skill\"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`. * `frontmatter.metadata.author:alice` to find skills whose frontmatter metadata `author` contains words that start with `alice`.", +"description": "Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * `skillId=\"urn:skill:projects-1234:locations:global:private-important-skill\"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`.", "location": "query", "type": "string" }, @@ -1565,7 +1565,7 @@ } } }, -"revision": "20260821", +"revision": "20260827", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 3b9ec056a8..0cf03a282d 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/aiplatform": { +"description": "See, edit, configure, and delete your Google Cloud Vertex AI data and see the email address for your Google Account" +}, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, @@ -467,6 +470,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -517,6 +521,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -563,6 +568,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -594,6 +600,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -627,6 +634,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -677,6 +685,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -723,6 +732,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -754,6 +764,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -784,6 +795,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -809,6 +821,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -840,6 +853,7 @@ "$ref": "GoogleCloudAiplatformV1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -888,6 +902,7 @@ "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -922,6 +937,7 @@ "$ref": "GoogleCloudAiplatformV1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -953,6 +969,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1003,6 +1020,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1049,6 +1067,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1080,6 +1099,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1115,6 +1135,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1165,6 +1186,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1211,6 +1233,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1242,6 +1265,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1273,6 +1297,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1323,6 +1348,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1369,6 +1395,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1400,6 +1427,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1434,6 +1462,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1459,6 +1488,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1490,6 +1520,7 @@ "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1542,6 +1573,7 @@ "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1576,6 +1608,7 @@ "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1601,6 +1634,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1630,6 +1664,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1680,6 +1715,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1726,6 +1762,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1757,6 +1794,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1788,6 +1826,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1838,6 +1877,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1884,6 +1924,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1915,6 +1956,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1950,6 +1992,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2000,6 +2043,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2046,6 +2090,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2077,6 +2122,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2167,6 +2213,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2196,6 +2243,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2225,6 +2273,7 @@ "$ref": "GoogleCloudAiplatformV1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2254,6 +2303,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2283,6 +2333,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2316,6 +2367,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2346,6 +2398,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2396,6 +2449,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2442,6 +2496,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2473,6 +2528,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2533,6 +2589,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2579,6 +2636,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2610,6 +2668,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2666,6 +2725,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2712,6 +2772,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2743,6 +2804,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2803,6 +2865,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2849,6 +2912,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2880,6 +2944,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2936,6 +3001,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2982,6 +3048,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3013,6 +3080,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3050,6 +3118,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3100,6 +3169,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3146,6 +3216,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3177,6 +3248,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3208,6 +3280,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3258,6 +3331,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3304,6 +3378,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3335,6 +3410,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3366,6 +3442,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3416,6 +3493,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3462,6 +3540,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3493,6 +3572,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3526,6 +3606,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3576,6 +3657,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3622,6 +3704,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3653,6 +3736,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3686,6 +3770,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3736,6 +3821,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3782,6 +3868,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3813,6 +3900,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3846,6 +3934,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3896,6 +3985,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3942,6 +4032,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3973,6 +4064,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4018,6 +4110,7 @@ "$ref": "GoogleCloudAiplatformV1UploadRagFileResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "supportsMediaUpload": true @@ -4052,6 +4145,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4102,6 +4196,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4148,6 +4243,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4179,6 +4275,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4210,6 +4307,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4260,6 +4358,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4306,6 +4405,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4337,6 +4437,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4372,6 +4473,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4422,6 +4524,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4468,6 +4571,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4499,6 +4603,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4532,6 +4637,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4582,6 +4688,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4628,6 +4735,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4659,6 +4767,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4692,6 +4801,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4742,6 +4852,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4788,6 +4899,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4819,6 +4931,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4850,6 +4963,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4900,6 +5014,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4946,6 +5061,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4977,6 +5093,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5010,6 +5127,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5060,6 +5178,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5106,6 +5225,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5137,6 +5257,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5170,6 +5291,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5220,6 +5342,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5266,6 +5389,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5297,6 +5421,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5332,6 +5457,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5382,6 +5508,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5428,6 +5555,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5459,6 +5587,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5490,6 +5619,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5540,6 +5670,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5586,6 +5717,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5617,6 +5749,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5650,6 +5783,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5700,6 +5834,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5746,6 +5881,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5777,6 +5913,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5810,6 +5947,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5860,6 +5998,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5906,6 +6045,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5937,6 +6077,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5970,6 +6111,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6020,6 +6162,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6066,6 +6209,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6097,6 +6241,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6130,6 +6275,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6180,6 +6326,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6226,6 +6373,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6257,6 +6405,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6288,6 +6437,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6338,6 +6488,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6380,6 +6531,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6411,6 +6563,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6442,6 +6595,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6492,6 +6646,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6538,6 +6693,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6569,6 +6725,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6602,6 +6759,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6652,6 +6810,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6698,6 +6857,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6729,6 +6889,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6820,6 +6981,7 @@ "$ref": "GoogleCloudAiplatformV1AskContextsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6848,6 +7010,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6876,6 +7039,7 @@ "$ref": "GoogleCloudAiplatformV1AugmentPromptResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6904,6 +7068,7 @@ "$ref": "GoogleCloudAiplatformV1CorroborateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6932,6 +7097,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6960,6 +7126,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6988,6 +7155,7 @@ "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7016,6 +7184,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7072,6 +7241,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7100,6 +7270,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateUserScenariosResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7150,6 +7321,7 @@ "$ref": "GoogleCloudAiplatformV1RagEngineConfig" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7250,6 +7422,7 @@ "$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7278,6 +7451,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7443,7 +7617,7 @@ ], "parameters": { "filter": { -"description": "Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields: * `created` * `updated` Both are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. Example: `created > \"2026-08-01T00:00:00Z\" AND updated < \"2026-08-09T00:00:00Z\"`. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`.", +"description": "Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields, and the operators each accepts: * `created` * `updated` * `base_agent` * `metadata.agent_type` `created` and `updated` are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. `metadata.agent_type` accepts only the value `\"default_agent\"`, matched exactly: `metadata.agent_type:\"default_agent\"` selects the caller's default agent, of which there is at most one, and the negated form selects the rest. Any other value is `INVALID_ARGUMENT` rather than an empty page -- `metadata` is an opaque blob, so only this one marker is indexed, and the server cannot answer a question about the others. An agent designated before the server began recording the marker is not matched by the positive form; there is no backfill. `base_agent` accepts `=` and `!=` against the value an agent was created with, and selects only among the agents you own: an agent that belongs to the project rather than to a user is never returned by a filter naming it, including the negated form. An agent created before the server began recording the value is not matched either. Example: `created > \"2026-08-01T00:00:00Z\" AND updated < \"2026-08-09T00:00:00Z\"`. IMPORTANT -- `base_agent` and `metadata.agent_type` select only among the agents you own. An agent that belongs to the project rather than to a user is never returned by a filter naming either of them, including a negated one: `base_agent != \"some-value\"` returns your matching agents and no project-owned agents at all. Filtering on `created` or `updated` alone is unaffected and still spans both. If you want every agent in the project, do not filter on these two fields. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`.", "location": "query", "type": "string" }, @@ -8035,6 +8209,7 @@ "$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8064,6 +8239,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8114,6 +8290,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8160,6 +8337,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8191,6 +8369,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8384,6 +8563,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8434,6 +8614,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8480,6 +8661,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8511,6 +8693,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8545,6 +8728,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8570,6 +8754,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8598,6 +8783,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8629,6 +8815,7 @@ "$ref": "GoogleCloudAiplatformV1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8688,6 +8875,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8740,6 +8928,7 @@ "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8774,6 +8963,7 @@ "$ref": "GoogleCloudAiplatformV1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8871,6 +9061,7 @@ "$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8965,6 +9156,7 @@ "$ref": "GoogleCloudAiplatformV1AnnotationSpec" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8994,6 +9186,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9044,6 +9237,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9090,6 +9284,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9121,6 +9316,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9179,6 +9375,7 @@ "$ref": "GoogleCloudAiplatformV1ListDataItemsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9235,6 +9432,7 @@ "$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9264,6 +9462,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9314,6 +9513,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9360,6 +9560,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9391,6 +9592,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9422,6 +9624,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9472,6 +9675,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9518,6 +9722,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9549,6 +9754,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9583,6 +9789,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9608,6 +9815,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9639,6 +9847,7 @@ "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9691,6 +9900,7 @@ "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9725,6 +9935,7 @@ "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9750,6 +9961,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9779,6 +9991,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9829,6 +10042,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9875,6 +10089,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9906,6 +10121,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9935,6 +10151,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9987,6 +10204,7 @@ "$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -10016,6 +10234,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10066,6 +10285,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10112,6 +10332,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10143,6 +10364,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -10364,6 +10586,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10414,6 +10637,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10460,6 +10684,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10491,6 +10716,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -10586,6 +10812,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10611,6 +10838,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10639,6 +10867,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10667,6 +10896,7 @@ "$ref": "GoogleCloudAiplatformV1DirectPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -10696,6 +10926,7 @@ "$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -10725,6 +10956,7 @@ "$ref": "GoogleCloudAiplatformV1ExplainResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -10754,6 +10986,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -10783,6 +11016,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -10809,6 +11043,7 @@ "$ref": "GoogleCloudAiplatformV1Endpoint" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10866,6 +11101,7 @@ "$ref": "GoogleCloudAiplatformV1ListEndpointsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10894,6 +11130,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10928,6 +11165,7 @@ "$ref": "GoogleCloudAiplatformV1Endpoint" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10956,6 +11194,7 @@ "$ref": "GoogleCloudAiplatformV1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -10985,6 +11224,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11014,6 +11254,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11043,6 +11284,7 @@ "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11072,6 +11314,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11101,6 +11344,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11130,6 +11374,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11158,6 +11403,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -11190,6 +11436,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11238,6 +11485,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11280,6 +11528,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11321,6 +11570,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11359,6 +11609,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11393,6 +11644,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11427,6 +11679,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11457,6 +11710,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11507,6 +11761,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11553,6 +11808,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11584,6 +11840,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -11613,6 +11870,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -11639,6 +11897,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -12772,6 +13031,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12818,6 +13078,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12849,6 +13110,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12905,6 +13167,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12951,6 +13214,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12982,6 +13246,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -13777,6 +14042,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13823,6 +14089,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13854,6 +14121,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -13910,6 +14178,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13956,6 +14225,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13987,6 +14257,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -14998,6 +15269,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15048,6 +15320,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15094,6 +15367,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15125,6 +15399,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -15156,6 +15431,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15206,6 +15482,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15252,6 +15529,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15283,6 +15561,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -15314,6 +15593,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15364,6 +15644,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15410,6 +15691,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15441,6 +15723,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -15629,6 +15912,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15679,6 +15963,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15725,6 +16010,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15756,6 +16042,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -16096,6 +16383,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16146,6 +16434,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16192,6 +16481,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16223,6 +16513,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -16473,6 +16764,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16523,6 +16815,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16569,6 +16862,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16600,6 +16894,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -16942,6 +17237,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16992,6 +17288,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17038,6 +17335,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17069,6 +17367,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -17170,6 +17469,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17220,6 +17520,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17266,6 +17567,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17297,6 +17599,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -17698,6 +18001,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17748,6 +18052,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17794,6 +18099,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17825,6 +18131,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -18175,6 +18482,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18225,6 +18533,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18271,6 +18580,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18302,6 +18612,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -18591,6 +18902,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18641,6 +18953,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18687,6 +19000,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18718,6 +19032,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -18852,6 +19167,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18902,6 +19218,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18948,6 +19265,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18979,6 +19297,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -19070,6 +19389,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19120,6 +19440,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19166,6 +19487,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19197,6 +19519,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -19475,6 +19798,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19525,6 +19849,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19571,6 +19896,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19602,6 +19928,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -19636,6 +19963,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19661,6 +19989,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19686,6 +20015,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19714,6 +20044,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19739,6 +20070,7 @@ "$ref": "GoogleCloudAiplatformV1Model" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19822,6 +20154,7 @@ "$ref": "GoogleCloudAiplatformV1ListModelsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19858,6 +20191,7 @@ "$ref": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19910,6 +20244,7 @@ "$ref": "GoogleCloudAiplatformV1ListModelVersionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19938,6 +20273,7 @@ "$ref": "GoogleCloudAiplatformV1Model" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19972,6 +20308,7 @@ "$ref": "GoogleCloudAiplatformV1Model" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20059,6 +20396,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20087,6 +20425,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20116,6 +20455,7 @@ "$ref": "GoogleCloudAiplatformV1ModelEvaluation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20144,6 +20484,7 @@ "$ref": "GoogleCloudAiplatformV1ModelEvaluation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20191,6 +20532,7 @@ "$ref": "GoogleCloudAiplatformV1ListModelEvaluationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20220,6 +20562,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20270,6 +20613,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20316,6 +20660,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20347,6 +20692,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20379,6 +20725,7 @@ "$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20404,6 +20751,7 @@ "$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20451,6 +20799,7 @@ "$ref": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20482,6 +20831,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20532,6 +20882,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20578,6 +20929,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20609,6 +20961,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -21028,6 +21381,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21078,6 +21432,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21124,6 +21479,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21155,6 +21511,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -21449,6 +21806,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21499,6 +21857,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21545,6 +21904,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21576,6 +21936,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -21825,6 +22186,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21875,6 +22237,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21921,6 +22284,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21952,6 +22316,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -22201,6 +22566,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22251,6 +22617,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22297,6 +22664,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22328,6 +22696,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -22359,6 +22728,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22409,6 +22779,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22455,6 +22826,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22486,6 +22858,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -22700,6 +23073,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22750,6 +23124,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22796,6 +23171,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22827,6 +23203,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -23081,6 +23458,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23131,6 +23509,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23177,6 +23556,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23208,6 +23588,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -23300,6 +23681,7 @@ "$ref": "GoogleCloudAiplatformV1EmbedContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23329,6 +23711,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23358,6 +23741,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23387,6 +23771,7 @@ "$ref": "GoogleCloudAiplatformV1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23416,6 +23801,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23445,6 +23831,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23474,6 +23861,7 @@ "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23503,6 +23891,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23532,6 +23921,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23571,6 +23961,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23611,6 +24002,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23649,6 +24041,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23675,6 +24068,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23701,6 +24095,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -23738,6 +24133,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23768,6 +24164,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23793,6 +24190,7 @@ "$ref": "GoogleCloudAiplatformV1RagCorpus" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23829,6 +24227,7 @@ "$ref": "GoogleCloudAiplatformV1ListRagCorporaResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23857,6 +24256,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -23886,6 +24286,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23936,6 +24337,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23982,6 +24384,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24013,6 +24416,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24047,6 +24451,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24072,6 +24477,7 @@ "$ref": "GoogleCloudAiplatformV1RagFile" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24100,6 +24506,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24136,6 +24543,7 @@ "$ref": "GoogleCloudAiplatformV1ListRagFilesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24165,6 +24573,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24215,6 +24624,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24261,6 +24671,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24292,6 +24703,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24327,6 +24739,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24377,6 +24790,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24423,6 +24837,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24454,6 +24869,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24544,6 +24960,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24574,6 +24991,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24627,6 +25045,7 @@ "$ref": "GoogleCloudAiplatformV1ReasoningEngine" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24699,6 +25118,7 @@ "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24733,6 +25153,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25184,6 +25605,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25234,6 +25656,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25280,6 +25703,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25311,6 +25735,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -25412,6 +25837,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25462,6 +25888,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25508,6 +25935,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25539,6 +25967,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -25723,6 +26152,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25773,6 +26203,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25804,6 +26235,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -25958,6 +26390,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26008,6 +26441,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26039,6 +26473,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -26333,6 +26768,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26383,6 +26819,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26414,6 +26851,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -26718,6 +27156,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26768,6 +27207,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26814,6 +27254,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26845,6 +27286,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -27096,6 +27538,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27146,6 +27589,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27192,6 +27636,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27223,6 +27668,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -27416,6 +27862,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27466,6 +27913,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27512,6 +27960,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27543,6 +27992,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -27608,6 +28058,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27658,6 +28109,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27704,6 +28156,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27735,6 +28188,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -27768,6 +28222,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27818,6 +28273,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27864,6 +28320,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27895,6 +28352,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28089,6 +28547,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28139,6 +28598,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28185,6 +28645,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28216,6 +28677,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28393,6 +28855,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28443,6 +28906,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28489,6 +28953,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28520,6 +28985,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28835,6 +29301,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28885,6 +29352,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28931,6 +29399,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28962,6 +29431,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28971,6 +29441,170 @@ } } }, +"taskStores": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.taskStores.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.taskStores.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.taskStores.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "tensorboards": { "methods": { "batchRead": { @@ -29477,6 +30111,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29527,6 +30162,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29573,6 +30209,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29604,6 +30241,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -29864,6 +30502,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29914,6 +30553,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29960,6 +30600,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29991,6 +30632,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30292,6 +30934,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30342,6 +30985,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30388,6 +31032,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30419,6 +31064,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30454,6 +31100,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30504,6 +31151,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30550,6 +31198,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30581,6 +31230,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30769,6 +31419,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30819,6 +31470,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30865,6 +31517,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30896,6 +31549,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30930,6 +31584,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30958,6 +31613,7 @@ "$ref": "GoogleCloudAiplatformV1TuningJob" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30983,6 +31639,7 @@ "$ref": "GoogleCloudAiplatformV1TuningJob" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31024,6 +31681,7 @@ "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31052,6 +31710,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31081,6 +31740,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31131,6 +31791,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31177,6 +31838,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31208,6 +31870,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31304,6 +31967,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -31333,6 +31997,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -31391,6 +32056,7 @@ "$ref": "GoogleCloudAiplatformV1PublisherModel" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31419,6 +32085,7 @@ "$ref": "GoogleCloudAiplatformV1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -31448,6 +32115,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -31477,6 +32145,7 @@ "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -31511,6 +32180,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31561,6 +32231,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31607,6 +32278,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31638,6 +32310,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31669,6 +32342,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31719,6 +32393,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31765,6 +32440,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31796,6 +32472,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31831,6 +32508,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31881,6 +32559,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31927,6 +32606,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31958,6 +32638,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -32044,6 +32725,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32074,6 +32756,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32127,6 +32810,7 @@ "$ref": "GoogleCloudAiplatformV1ReasoningEngine" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32164,6 +32848,7 @@ "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32198,6 +32883,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32285,6 +32971,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32335,6 +33022,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32381,6 +33069,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32412,6 +33101,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -32443,6 +33133,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32493,6 +33184,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32539,6 +33231,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32570,6 +33263,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -32754,6 +33448,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32804,6 +33499,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32835,6 +33531,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -32989,6 +33686,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33039,6 +33737,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33070,6 +33769,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33364,6 +34064,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33414,6 +34115,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33445,6 +34147,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33478,6 +34181,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33528,6 +34232,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33574,6 +34279,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33605,6 +34311,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33640,6 +34347,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33690,6 +34398,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33736,6 +34445,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33767,6 +34477,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33800,6 +34511,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33850,6 +34562,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33896,6 +34609,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33927,6 +34641,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33960,6 +34675,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34010,6 +34726,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34056,6 +34773,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34087,6 +34805,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -34120,6 +34839,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34170,6 +34890,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34216,6 +34937,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34247,6 +34969,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -34280,6 +35003,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34330,6 +35054,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34376,6 +35101,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34407,6 +35133,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -34440,6 +35167,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34490,6 +35218,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34536,6 +35265,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34567,6 +35297,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -34598,6 +35329,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34648,6 +35380,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34694,6 +35427,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34725,10 +35459,175 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"taskStores": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/taskStores/{taskStoresId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.taskStores.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.taskStores.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.taskStores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/taskStores/{taskStoresId}/operations", +"httpMethod": "GET", +"id": "aiplatform.taskStores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^taskStores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/taskStores/{taskStoresId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.taskStores.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" } +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -34762,6 +35661,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34812,6 +35712,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34858,6 +35759,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34889,6 +35791,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -34920,6 +35823,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34970,6 +35874,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35016,6 +35921,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35047,6 +35953,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35078,6 +35985,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35128,6 +36036,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35174,6 +36083,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35205,6 +36115,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35240,6 +36151,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35290,6 +36202,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35336,6 +36249,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35367,6 +36281,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35400,6 +36315,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35450,6 +36366,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35496,6 +36413,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35527,6 +36445,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35560,6 +36479,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35610,6 +36530,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35656,6 +36577,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35687,6 +36609,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35711,6 +36634,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35729,6 +36653,7 @@ "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35747,13 +36672,14 @@ "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } } } }, -"revision": "20260822", +"revision": "20260831", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -36882,6 +37808,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1AgentResponseCustomization": { +"description": "Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial).", +"id": "GoogleCloudAiplatformV1AgentResponseCustomization", +"properties": { +"denialMessage": { +"description": "Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1AgentTool": { "description": "A tool provides a list of actions available to the Agent during the process of executing a task.", "id": "GoogleCloudAiplatformV1AgentTool", @@ -36894,15 +37831,15 @@ "type": "object" }, "name": { -"description": "Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.", +"description": "Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`.", "type": "string" }, "type": { -"description": "Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`", +"description": "Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context`", "type": "string" }, "url": { -"description": "Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.", +"description": "Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation.", "type": "string" } }, @@ -48214,6 +49151,10 @@ "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" +}, +"translationConfig": { +"$ref": "GoogleCloudAiplatformV1TranslationConfig", +"description": "Optional. Config for translation." } }, "type": "object" @@ -61248,6 +62189,9 @@ false "STATE_DEPROVISIONING", "STATE_TERMINATED", "STATE_DELETED", +"STATE_PAUSED", +"STATE_PAUSING", +"STATE_RESUMING", "STATE_STOPPING" ], "enumDescriptions": [ @@ -61257,6 +62201,9 @@ false "Sandbox runtime is halted, performing tear down tasks.", "Sandbox has terminated with underlying runtime failure.", "Sandbox runtime has been deleted.", +"Sandbox runtime is paused.", +"Sandbox runtime is pausing.", +"Sandbox runtime is resuming.", "Sandbox runtime is stopping." ], "readOnly": true, @@ -66507,6 +67454,10 @@ false "readOnly": true, "type": "string" }, +"agentResponseCustomization": { +"$ref": "GoogleCloudAiplatformV1AgentResponseCustomization", +"description": "Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request." +}, "createTime": { "description": "Output only. Timestamp when this SemanticGovernancePolicy was created.", "format": "google-datetime", @@ -70008,6 +70959,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1TranslationConfig": { +"description": "Config for translation features.", +"id": "GoogleCloudAiplatformV1TranslationConfig", +"properties": { +"echoTargetLanguage": { +"description": "Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language.", +"type": "boolean" +}, +"targetLanguageCode": { +"description": "Required. The target language for translation. Supported values are BCP-47 language codes (e.g. \"en\", \"es\", \"fr\").", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Trial": { "description": "A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.", "id": "GoogleCloudAiplatformV1Trial", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 2d13dc3ef7..e67863957d 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/aiplatform": { +"description": "See, edit, configure, and delete your Google Cloud Vertex AI data and see the email address for your Google Account" +}, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, @@ -371,6 +374,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -421,6 +425,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -467,6 +472,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -498,6 +504,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -531,6 +538,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -581,6 +589,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -627,6 +636,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -658,6 +668,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -787,6 +798,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -837,6 +849,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -883,6 +896,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -914,6 +928,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -947,6 +962,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -997,6 +1013,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1043,6 +1060,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1074,6 +1092,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1104,6 +1123,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1129,6 +1149,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1160,6 +1181,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1208,6 +1230,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1242,6 +1265,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1273,6 +1297,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1323,6 +1348,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1369,6 +1395,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1400,6 +1427,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1435,6 +1463,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1485,6 +1514,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1531,6 +1561,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1562,6 +1593,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1593,6 +1625,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1643,6 +1676,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1689,6 +1723,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1720,6 +1755,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1754,6 +1790,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1779,6 +1816,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1810,6 +1848,7 @@ "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1862,6 +1901,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1896,6 +1936,7 @@ "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1921,6 +1962,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1950,6 +1992,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2000,6 +2043,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2046,6 +2090,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2077,6 +2122,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2108,6 +2154,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2158,6 +2205,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2204,6 +2252,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2235,6 +2284,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2270,6 +2320,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2320,6 +2371,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2366,6 +2418,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2397,6 +2450,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2430,6 +2484,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2480,6 +2535,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2526,6 +2582,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2557,6 +2614,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2619,6 +2677,7 @@ "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2648,6 +2707,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2677,6 +2737,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2706,6 +2767,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2735,6 +2797,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2764,6 +2827,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2797,6 +2861,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -2827,6 +2892,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2877,6 +2943,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2923,6 +2990,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2954,6 +3022,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3012,6 +3081,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3058,6 +3128,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3089,6 +3160,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3147,6 +3219,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3193,6 +3266,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3251,6 +3325,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3297,6 +3372,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3328,6 +3404,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3386,6 +3463,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3432,6 +3510,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3463,6 +3542,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3521,6 +3601,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3567,6 +3648,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3598,6 +3680,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3631,6 +3714,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3681,6 +3765,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3727,6 +3812,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3758,6 +3844,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3791,6 +3878,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3841,6 +3929,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3887,6 +3976,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3918,6 +4008,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3951,6 +4042,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4001,6 +4093,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4047,6 +4140,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4078,6 +4172,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4138,6 +4233,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4184,6 +4280,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4215,6 +4312,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4273,6 +4371,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4319,6 +4418,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4350,6 +4450,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4406,6 +4507,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4452,6 +4554,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4483,6 +4586,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4543,6 +4647,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4589,6 +4694,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4620,6 +4726,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4676,6 +4783,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4722,6 +4830,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4753,6 +4862,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4790,6 +4900,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4840,6 +4951,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4886,6 +4998,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4917,6 +5030,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4948,6 +5062,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4998,6 +5113,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5044,6 +5160,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5075,6 +5192,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5106,6 +5224,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5156,6 +5275,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5202,6 +5322,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5233,6 +5354,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5266,6 +5388,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5316,6 +5439,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5362,6 +5486,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5393,6 +5518,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5426,6 +5552,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5476,6 +5603,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5522,6 +5650,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5553,6 +5682,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5586,6 +5716,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5636,6 +5767,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5682,6 +5814,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5713,6 +5846,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5869,6 +6003,7 @@ "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ], "supportsMediaUpload": true @@ -6238,6 +6373,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6288,6 +6424,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6334,6 +6471,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6365,6 +6503,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6466,6 +6605,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6516,6 +6656,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6562,6 +6703,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6593,6 +6735,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6628,6 +6771,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6678,6 +6822,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6724,6 +6869,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6755,6 +6901,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6788,6 +6935,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6838,6 +6986,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6884,6 +7033,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6915,6 +7065,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -6948,6 +7099,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -6998,6 +7150,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7044,6 +7197,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7075,6 +7229,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -7106,6 +7261,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7156,6 +7312,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7202,6 +7359,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7233,6 +7391,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -7266,6 +7425,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7316,6 +7476,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7362,6 +7523,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7393,6 +7555,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -7426,6 +7589,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7476,6 +7640,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7522,6 +7687,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7553,6 +7719,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -7586,6 +7753,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7636,6 +7804,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7682,6 +7851,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7713,6 +7883,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -7748,6 +7919,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7798,6 +7970,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7844,6 +8017,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7875,6 +8049,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -7906,6 +8081,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7956,6 +8132,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8002,6 +8179,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8033,6 +8211,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8066,6 +8245,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8116,6 +8296,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8162,6 +8343,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8193,6 +8375,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8226,6 +8409,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8276,6 +8460,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8322,6 +8507,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8353,6 +8539,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8386,6 +8573,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8436,6 +8624,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8482,6 +8671,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8513,6 +8703,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8546,6 +8737,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8596,6 +8788,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8642,6 +8835,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8673,6 +8867,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8704,6 +8899,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8754,6 +8950,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8796,6 +8993,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8827,6 +9025,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -8858,6 +9057,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8908,6 +9108,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8954,6 +9155,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -8985,6 +9187,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9018,6 +9221,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9068,6 +9272,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9114,6 +9319,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9145,6 +9351,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -9176,6 +9383,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9229,6 +9437,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9289,6 +9498,7 @@ "$ref": "GoogleCloudAiplatformV1beta1AskContextsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9317,6 +9527,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9345,6 +9556,7 @@ "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9373,6 +9585,7 @@ "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9401,6 +9614,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9430,6 +9644,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9458,6 +9673,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9486,6 +9702,7 @@ "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9514,6 +9731,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9570,6 +9788,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9598,6 +9817,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9648,6 +9868,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9748,6 +9969,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9776,6 +9998,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -9804,6 +10027,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10092,7 +10316,7 @@ ], "parameters": { "filter": { -"description": "Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields: * `created` * `updated` Both are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. Example: `created > \"2026-08-01T00:00:00Z\" AND updated < \"2026-08-09T00:00:00Z\"`. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`.", +"description": "Optional. An [AIP-160](https://google.aip.dev/160) filter over the returned agents. An empty filter returns the unfiltered collection. Supported fields, and the operators each accepts: * `created` * `updated` * `base_agent` * `metadata.agent_type` `created` and `updated` are timestamps and take an RFC-3339 value, for example `2026-08-01T00:00:00Z`. Supported operators: `=`, `!=`, `<`, `>`, `<=`, `>=`, `:`, `AND`, `OR`, `NOT` (equivalently `-`), and parentheses. Note that `OR` binds more tightly than `AND`, so `a AND b OR c` means `a AND (b OR c)`; parentheses are recommended, not required. `metadata.agent_type` accepts only the value `\"default_agent\"`, matched exactly: `metadata.agent_type:\"default_agent\"` selects the caller's default agent, of which there is at most one, and the negated form selects the rest. Any other value is `INVALID_ARGUMENT` rather than an empty page -- `metadata` is an opaque blob, so only this one marker is indexed, and the server cannot answer a question about the others. An agent designated before the server began recording the marker is not matched by the positive form; there is no backfill. `base_agent` accepts `=` and `!=` against the value an agent was created with, and selects only among the agents you own: an agent that belongs to the project rather than to a user is never returned by a filter naming it, including the negated form. An agent created before the server began recording the value is not matched either. Example: `created > \"2026-08-01T00:00:00Z\" AND updated < \"2026-08-09T00:00:00Z\"`. IMPORTANT -- `base_agent` and `metadata.agent_type` select only among the agents you own. An agent that belongs to the project rather than to a user is never returned by a filter naming either of them, including a negated one: `base_agent != \"some-value\"` returns your matching agents and no project-owned agents at all. Filtering on `created` or `updated` alone is unaffected and still spans both. If you want every agent in the project, do not filter on these two fields. Not supported: any field other than those listed above, wildcards other than `field:*`, bare literals with no field name, functions, and the regular-expression operators `=~` and `!~`. A filter that names an unsupported field, exceeds 1000 characters, or nests parentheses more than 5 deep fails with `INVALID_ARGUMENT`.", "location": "query", "type": "string" }, @@ -10247,6 +10471,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10297,6 +10522,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10343,6 +10569,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10374,6 +10601,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -10407,6 +10635,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10457,6 +10686,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10503,6 +10733,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10534,6 +10765,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -11002,6 +11234,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -11031,6 +11264,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11081,6 +11315,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11127,6 +11362,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11158,6 +11394,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -11351,6 +11588,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11401,6 +11639,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11447,6 +11686,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11478,6 +11718,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -11512,6 +11753,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11540,6 +11782,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11568,6 +11811,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11593,6 +11837,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11621,6 +11866,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11652,6 +11898,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11711,6 +11958,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11763,6 +12011,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11797,6 +12046,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Dataset" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11894,6 +12144,7 @@ "$ref": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11988,6 +12239,7 @@ "$ref": "GoogleCloudAiplatformV1beta1AnnotationSpec" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12017,6 +12269,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12067,6 +12320,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12113,6 +12367,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12144,6 +12399,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12202,6 +12458,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListDataItemsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12258,6 +12515,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12287,6 +12545,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12337,6 +12596,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12383,6 +12643,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12414,6 +12675,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12445,6 +12707,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12495,6 +12758,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12541,6 +12805,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12572,6 +12837,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12606,6 +12872,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12631,6 +12898,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12662,6 +12930,7 @@ "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12714,6 +12983,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12748,6 +13018,7 @@ "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12773,6 +13044,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12802,6 +13074,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12852,6 +13125,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12898,6 +13172,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -12929,6 +13204,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -12958,6 +13234,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13010,6 +13287,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -13039,6 +13317,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13089,6 +13368,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13135,6 +13415,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13166,6 +13447,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -13387,6 +13669,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13437,6 +13720,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13483,6 +13767,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13514,6 +13799,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -13547,6 +13833,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13597,6 +13884,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13643,6 +13931,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13674,6 +13963,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -13736,6 +14026,7 @@ "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -13770,6 +14061,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13795,6 +14087,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13823,6 +14116,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -13851,6 +14145,7 @@ "$ref": "GoogleCloudAiplatformV1beta1DirectPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -13880,6 +14175,7 @@ "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -13909,6 +14205,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ExplainResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -13938,6 +14235,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -13967,6 +14265,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -13993,6 +14292,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14076,6 +14376,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListEndpointsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14104,6 +14405,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14138,6 +14440,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Endpoint" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14166,6 +14469,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14195,6 +14499,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14224,6 +14529,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14253,6 +14559,7 @@ "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14310,6 +14617,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14339,6 +14647,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14399,6 +14708,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14427,6 +14737,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -14459,6 +14770,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14507,6 +14819,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14549,6 +14862,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14590,6 +14904,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14628,6 +14943,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14662,6 +14978,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14696,6 +15013,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14726,6 +15044,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14776,6 +15095,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14822,6 +15142,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -14853,6 +15174,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -14882,6 +15204,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -14908,6 +15231,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -15093,6 +15417,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15139,6 +15464,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15170,6 +15496,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -15359,6 +15686,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15405,6 +15733,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -15617,6 +15946,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15663,6 +15993,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15694,6 +16025,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -15940,6 +16272,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -15986,6 +16319,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16017,6 +16351,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -16075,6 +16410,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16121,6 +16457,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16152,6 +16489,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -16481,6 +16819,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16531,6 +16870,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16577,6 +16917,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16608,6 +16949,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -16641,6 +16983,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16691,6 +17034,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16737,6 +17081,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -16768,6 +17113,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -17018,6 +17364,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17068,6 +17415,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17114,6 +17462,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17145,6 +17494,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -17739,6 +18089,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17785,6 +18136,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -17816,6 +18168,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -18097,6 +18450,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18143,6 +18497,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18174,6 +18529,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -18230,6 +18586,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18276,6 +18633,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -18307,6 +18665,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -19130,6 +19489,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19176,6 +19536,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19207,6 +19568,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -19263,6 +19625,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19309,6 +19672,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -19340,6 +19704,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20363,6 +20728,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20413,6 +20779,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20459,6 +20826,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20490,6 +20858,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20521,6 +20890,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20571,6 +20941,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20617,6 +20988,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20648,6 +21020,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20679,6 +21052,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20729,6 +21103,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20775,6 +21150,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -20806,6 +21182,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -20994,6 +21371,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21044,6 +21422,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21090,6 +21469,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21121,6 +21501,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -21461,6 +21842,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21511,6 +21893,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21557,6 +21940,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21588,6 +21972,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -21866,6 +22251,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21916,6 +22302,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21962,6 +22349,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -21993,6 +22381,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -22094,6 +22483,104 @@ } } }, +"interactionsHttp": { +"methods": { +"cancel": { +"description": "Cancels an interaction.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}/cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.interactionsHttp.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the interaction to cancel. Format: `interactions/{interaction}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/interactionsHttp/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/cancel", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Generates a set of responses from the model.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.interactionsHttp.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this interaction will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API only.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/interactionsHttp", +"request": { +"$ref": "GenaiVertexV1beta1CreateInteractionHttpRequest" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an interaction.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactionsHttp/{interactionsHttpId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.interactionsHttp.get", +"parameterOrder": [ +"name" +], +"parameters": { +"includeInput": { +"deprecated": true, +"description": "If true, includes the input in the response.", +"location": "query", +"type": "boolean" +}, +"lastEventId": { +"description": "If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the interaction to retrieve. Format: interactions/{interaction}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/interactionsHttp/[^/]+$", +"required": true, +"type": "string" +}, +"stream": { +"description": "If true, streams the interaction events as Server-Sent Events.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "memoryBanks": { "methods": { "ingestEvents": { @@ -22457,6 +22944,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22507,6 +22995,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22553,6 +23042,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22584,6 +23074,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -22685,6 +23176,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22735,6 +23227,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22781,6 +23274,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -22812,6 +23306,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -23213,6 +23708,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23263,6 +23759,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23309,6 +23806,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23340,6 +23838,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -23690,6 +24189,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23740,6 +24240,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23786,6 +24287,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -23817,6 +24319,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24106,6 +24609,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24156,6 +24660,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24202,6 +24707,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24233,6 +24739,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24367,6 +24874,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24417,6 +24925,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24463,6 +24972,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24494,6 +25004,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24585,6 +25096,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24635,6 +25147,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24681,6 +25194,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -24712,6 +25226,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -24990,6 +25505,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25040,6 +25556,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25086,6 +25603,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25117,6 +25635,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -25511,6 +26030,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25561,6 +26081,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25607,6 +26128,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25638,6 +26160,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -25672,6 +26195,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25697,6 +26221,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25722,6 +26247,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25750,6 +26276,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25775,6 +26302,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Model" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25853,6 +26381,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListModelsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25889,6 +26418,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25941,6 +26471,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -25969,6 +26500,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Model" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26003,6 +26535,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Model" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26090,6 +26623,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26118,6 +26652,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -26147,6 +26682,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26175,6 +26711,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26222,6 +26759,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -26251,6 +26789,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26301,6 +26840,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26347,6 +26887,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26378,6 +26919,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -26410,6 +26952,7 @@ "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26435,6 +26978,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26482,6 +27026,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -26513,6 +27058,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26563,6 +27109,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26609,6 +27156,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -26640,6 +27188,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -27456,6 +28005,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27506,6 +28056,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27552,6 +28103,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27583,6 +28135,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -27877,6 +28430,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27927,6 +28481,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -27973,6 +28528,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28004,6 +28560,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28309,6 +28866,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28359,6 +28917,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28405,6 +28964,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28436,6 +28996,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28685,6 +29246,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28735,6 +29297,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28781,6 +29344,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28812,6 +29376,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -28843,6 +29408,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28893,6 +29459,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28939,6 +29506,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -28970,6 +29538,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -29184,6 +29753,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29234,6 +29804,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29280,6 +29851,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29311,6 +29883,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -29565,6 +30138,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29615,6 +30189,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29661,6 +30236,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29692,6 +30268,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -29756,6 +30333,7 @@ "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -29785,6 +30363,7 @@ "$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -29822,6 +30401,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29850,6 +30430,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -29876,6 +30457,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -29904,6 +30486,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -29964,6 +30547,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -29993,6 +30577,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30022,6 +30607,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30051,6 +30637,7 @@ "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30080,6 +30667,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30108,6 +30696,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30137,6 +30726,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30176,6 +30766,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30216,6 +30807,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30254,6 +30846,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30280,6 +30873,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30306,6 +30900,7 @@ "$ref": "GoogleApiHttpBody" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -30343,6 +30938,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30378,6 +30974,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30403,6 +31000,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30439,6 +31037,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30467,6 +31066,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30496,6 +31096,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30546,6 +31147,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30592,6 +31194,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30623,6 +31226,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30655,6 +31259,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30683,6 +31288,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30716,6 +31322,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30741,6 +31348,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30766,6 +31374,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagDataSchema" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30802,6 +31411,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListRagDataSchemasResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30836,6 +31446,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30861,6 +31472,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagFile" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30889,6 +31501,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -30925,6 +31538,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -30954,6 +31568,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31004,6 +31619,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31050,6 +31666,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31081,6 +31698,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31113,6 +31731,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31141,6 +31760,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31174,6 +31794,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31199,6 +31820,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31224,6 +31846,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31260,6 +31883,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListRagMetadataResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31288,6 +31912,7 @@ "$ref": "GoogleCloudAiplatformV1beta1RagMetadata" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31323,6 +31948,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31373,6 +31999,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31419,6 +32046,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31450,6 +32078,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -31540,6 +32169,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31570,6 +32200,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31623,6 +32254,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31695,6 +32327,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -31729,6 +32362,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -32969,6 +33603,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33019,6 +33654,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33050,6 +33686,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33302,6 +33939,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33352,6 +33990,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33398,6 +34037,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33429,6 +34069,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -33795,6 +34436,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33845,6 +34487,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33891,6 +34534,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -33922,6 +34566,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -34023,6 +34668,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34073,6 +34719,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34119,6 +34766,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -34150,6 +34798,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35196,6 +35845,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35246,6 +35896,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35292,6 +35943,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35323,6 +35975,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35449,6 +36102,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35499,6 +36153,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35545,6 +36200,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35576,6 +36232,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35730,6 +36387,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35780,6 +36438,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35826,6 +36485,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -35857,6 +36517,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -35894,6 +36555,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bidiExecute": { +"description": "Executes using a sandbox environment with bidirectional streaming.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:bidiExecute", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.bidiExecute", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:bidiExecute", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Creates a SandboxEnvironment in a given reasoning engine.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", @@ -36151,6 +36840,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36201,6 +36891,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36247,6 +36938,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36278,6 +36970,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -36582,6 +37275,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36632,6 +37326,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36678,6 +37373,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36709,6 +37405,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -36960,6 +37657,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37010,6 +37708,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37056,6 +37755,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37087,6 +37787,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -37280,6 +37981,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37330,6 +38032,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37376,6 +38079,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37407,6 +38111,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -37627,6 +38332,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37677,6 +38383,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37723,6 +38430,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -37754,6 +38462,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -37978,6 +38687,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38028,6 +38738,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38074,6 +38785,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38105,6 +38817,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -38233,6 +38946,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38279,6 +38993,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -38473,6 +39188,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38523,6 +39239,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38569,6 +39286,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38600,6 +39318,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -38777,6 +39496,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38827,6 +39547,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38873,6 +39594,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -38904,6 +39626,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -39219,6 +39942,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -39269,6 +39993,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -39315,6 +40040,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -39346,10 +40072,403 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"taskStores": { +"resources": { +"a2aTaskRecords": { +"methods": { +"appendEvents": { +"description": "Appends A2ATaskRecordEvents to an A2ATaskRecord.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}:appendEvents", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.appendEvents", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the A2ATaskRecord to append events to. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:appendEvents", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates an A2ATaskRecord.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"a2aTaskRecordId": { +"description": "Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the TaskStore to create the A2ATaskRecord under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/a2aTaskRecords", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an A2ATaskRecord.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the A2ATaskRecord to delete. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an A2ATaskRecord.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the A2ATaskRecord. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. The view of the A2ATaskRecord to return.", +"enum": [ +"A2A_TASK_RECORD_VIEW_UNSPECIFIED", +"A2A_TASK_RECORD_VIEW_BASIC", +"A2A_TASK_RECORD_VIEW_FULL" +], +"enumDescriptions": [ +"Task view unspecified.", +"Task header only (status, metadata, timestamps)", +"Full materialized state (artifacts + history)" +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists A2ATaskRecords in a TaskStore.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `context_id` * `status.state` Example: `context_id=\"abc\"`, `status.state=\"WORKING\"`.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. If this field is omitted, the default ordering is `create_time` descending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecords call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the TaskStore to list the A2ATaskRecords under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/a2aTaskRecords", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"events": { +"methods": { +"list": { +"description": "Lists TaskEvents for an A2ATaskRecord.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/a2aTaskRecords/{a2aTaskRecordsId}/events", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.a2aTaskRecords.events.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. Supported fields: * `create_time` range (i.e. `create_time>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order the results by. If this field is omitted, the results will be ordered by `generation` in ascending order. For each field, the default sort order is ascending. To specify descending order for a field, append a ` desc` suffix. For example: `create_time desc`. Supported fields: * `create_time` * `generation`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list A2ATaskRecordService.ListA2ATaskRecordEvents call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the A2ATaskRecord to list the TaskEvents under. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/a2aTaskRecords/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/events", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.taskStores.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.taskStores.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.taskStores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/taskStores/{taskStoresId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.taskStores.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" } +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -39861,6 +40980,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -39911,6 +41031,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -39957,6 +41078,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -39988,6 +41110,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -40248,6 +41371,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40298,6 +41422,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40344,6 +41469,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40375,6 +41501,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -40676,6 +41803,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40726,6 +41854,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40772,6 +41901,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40803,6 +41933,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -40838,6 +41969,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40888,6 +42020,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40934,6 +42067,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40965,6 +42099,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -41153,6 +42288,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41203,6 +42339,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41249,6 +42386,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41280,6 +42418,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -41314,6 +42453,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41342,6 +42482,7 @@ "$ref": "GoogleCloudAiplatformV1beta1TuningJob" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41367,6 +42508,7 @@ "$ref": "GoogleCloudAiplatformV1beta1TuningJob" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41408,6 +42550,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41436,6 +42579,7 @@ "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41464,6 +42608,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41492,6 +42637,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41520,6 +42666,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -41549,6 +42696,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41599,6 +42747,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41630,6 +42779,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -41666,6 +42816,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41694,6 +42845,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -41736,6 +42888,7 @@ "$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -41802,6 +42955,7 @@ "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -41831,6 +42985,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -41860,6 +43015,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -41923,6 +43079,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -41996,6 +43153,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42024,6 +43182,7 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -42053,6 +43212,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -42082,6 +43242,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] @@ -42116,6 +43277,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42166,6 +43328,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42212,6 +43375,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42243,6 +43407,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -42274,6 +43439,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42324,6 +43490,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42370,6 +43537,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42401,6 +43569,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -42436,6 +43605,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42486,6 +43656,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42532,6 +43703,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42563,6 +43735,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -42649,6 +43822,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42679,6 +43853,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42732,6 +43907,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42769,6 +43945,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -42803,6 +43980,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -43756,6 +44934,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -43806,6 +44985,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -43837,6 +45017,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -43870,6 +45051,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -43920,6 +45102,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -43966,6 +45149,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -43997,6 +45181,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -44363,6 +45548,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -44413,6 +45599,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -44459,6 +45646,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -44490,6 +45678,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -44591,6 +45780,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -44641,6 +45831,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -44687,6 +45878,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -44718,6 +45910,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -45673,6 +46866,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -45723,6 +46917,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -45769,6 +46964,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -45800,6 +46996,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -45926,6 +47123,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -45976,6 +47174,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46022,6 +47221,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46053,6 +47253,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -46207,6 +47408,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46257,6 +47459,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46303,6 +47506,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46334,6 +47538,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -46371,6 +47576,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"bidiExecute": { +"description": "Executes using a sandbox environment with bidirectional streaming.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:bidiExecute", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.sandboxEnvironments.bidiExecute", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:bidiExecute", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Creates a SandboxEnvironment in a given reasoning engine.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", @@ -46628,6 +47861,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46678,6 +47912,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46724,6 +47959,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -46755,6 +47991,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47031,6 +48268,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47081,6 +48319,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47127,6 +48366,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47158,6 +48398,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47193,6 +48434,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47243,6 +48485,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47289,6 +48532,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47320,6 +48564,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47353,6 +48598,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47403,6 +48649,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47449,6 +48696,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47480,6 +48728,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47513,6 +48762,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47563,6 +48813,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47609,6 +48860,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47640,6 +48892,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47673,6 +48926,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47723,6 +48977,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47769,6 +49024,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47800,6 +49056,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47858,6 +49115,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47904,6 +49162,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -47937,6 +49196,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -47987,6 +49247,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48033,6 +49294,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48064,6 +49326,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -48097,6 +49360,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48147,6 +49411,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48193,6 +49458,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48224,6 +49490,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -48255,6 +49522,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48305,6 +49573,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48351,6 +49620,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48382,10 +49652,175 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"taskStores": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.taskStores.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.taskStores.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.taskStores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/taskStores/{taskStoresId}/operations", +"httpMethod": "GET", +"id": "aiplatform.taskStores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^taskStores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/taskStores/{taskStoresId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.taskStores.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^taskStores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" } +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -48419,6 +49854,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48469,6 +49905,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48515,6 +49952,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48546,6 +49984,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -48577,6 +50016,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48627,6 +50067,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48673,6 +50114,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48704,6 +50146,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -48735,6 +50178,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48785,6 +50229,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48831,6 +50276,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48862,6 +50308,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -48897,6 +50344,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48947,6 +50395,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -48993,6 +50442,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49024,6 +50474,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -49057,6 +50508,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49107,6 +50559,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49153,6 +50606,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49184,6 +50638,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -49217,6 +50672,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49267,6 +50723,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49298,6 +50755,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -49322,6 +50780,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49340,6 +50799,7 @@ "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -49358,6 +50818,7 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -49428,7 +50889,7 @@ } } }, -"revision": "20260822", +"revision": "20260831", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -50902,6 +52363,17 @@ }, "type": "object" }, +"GenaiVertexV1beta1CreateInteractionHttpRequest": { +"description": "Request message for [InteractionsService.CreateInteractionHttp].", +"id": "GenaiVertexV1beta1CreateInteractionHttpRequest", +"properties": { +"httpBody": { +"$ref": "GoogleApiHttpBody", +"description": "Required. The interaction to create." +} +}, +"type": "object" +}, "GenaiVertexV1beta1CreateInteractionRequest": { "description": "Configuration parameters for creating an interaction.", "id": "GenaiVertexV1beta1CreateInteractionRequest", @@ -52439,14 +53911,17 @@ "properties": { "contentDelta": { "$ref": "GenaiVertexV1beta1ContentDelta", +"deprecated": true, "description": "The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled." }, "contentStart": { "$ref": "GenaiVertexV1beta1ContentStart", +"deprecated": true, "description": "The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled." }, "contentStop": { "$ref": "GenaiVertexV1beta1ContentStop", +"deprecated": true, "description": "The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled." }, "errorEvent": { @@ -52864,6 +54339,30 @@ }, "type": "object" }, +"GenaiVertexV1beta1ProcessingCallDelta": { +"description": "Streaming delta for a server-initiated media processing step.", +"id": "GenaiVertexV1beta1ProcessingCallDelta", +"properties": {}, +"type": "object" +}, +"GenaiVertexV1beta1ProcessingCallStep": { +"description": "A server-initiated processing step for media analysis (e.g. video understanding).", +"id": "GenaiVertexV1beta1ProcessingCallStep", +"properties": {}, +"type": "object" +}, +"GenaiVertexV1beta1ProcessingResultDelta": { +"description": "Streaming delta for the result of a server-initiated media processing step.", +"id": "GenaiVertexV1beta1ProcessingResultDelta", +"properties": {}, +"type": "object" +}, +"GenaiVertexV1beta1ProcessingResultStep": { +"description": "The result of a server-initiated media processing step.", +"id": "GenaiVertexV1beta1ProcessingResultStep", +"properties": {}, +"type": "object" +}, "GenaiVertexV1beta1RagStoreConfig": { "description": "Use to specify configuration for RAG Store.", "id": "GenaiVertexV1beta1RagStoreConfig", @@ -53284,6 +54783,9 @@ false "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallDelta" }, +"processingCall": { +"$ref": "GenaiVertexV1beta1ProcessingCallDelta" +}, "retrievalCall": { "$ref": "GenaiVertexV1beta1RetrievalCallDelta" }, @@ -53316,6 +54818,9 @@ false "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultDelta" }, +"processingResult": { +"$ref": "GenaiVertexV1beta1ProcessingResultDelta" +}, "retrievalResult": { "$ref": "GenaiVertexV1beta1RetrievalResultDelta" }, @@ -53813,6 +55318,9 @@ false "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallStep" }, +"processingCall": { +"$ref": "GenaiVertexV1beta1ProcessingCallStep" +}, "retrievalCall": { "$ref": "GenaiVertexV1beta1RetrievalCallStep" }, @@ -53938,6 +55446,9 @@ false "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultStep" }, +"processingResult": { +"$ref": "GenaiVertexV1beta1ProcessingResultStep" +}, "retrievalResult": { "$ref": "GenaiVertexV1beta1RetrievalResultStep" }, @@ -54300,6 +55811,10 @@ false "description": "Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the \"mime_type\" JSON key.", "type": "string" }, +"name": { +"description": "A user-defined name for this content block. Can be referenced by the model in the final response.", +"type": "string" +}, "processingConfig": { "$ref": "GenaiVertexV1beta1VideoContentMediaProcessing" }, @@ -54545,18 +56060,14 @@ false }, "type": "object" }, -"GoogleCloudAiplatformV1beta1A2aPart": { +"GoogleCloudAiplatformV1beta1A2APart": { "description": "A single part of a message or artifact. A part carries exactly one kind of content.", -"id": "GoogleCloudAiplatformV1beta1A2aPart", +"id": "GoogleCloudAiplatformV1beta1A2APart", "properties": { "data": { -"additionalProperties": { -"description": "Properties of the object.", +"description": "Optional. Arbitrary data content.", "type": "any" }, -"description": "Optional. Structured data content.", -"type": "object" -}, "filename": { "description": "Optional. The name of the file, when the part represents a file.", "type": "string" @@ -54589,9 +56100,9 @@ false }, "type": "object" }, -"GoogleCloudAiplatformV1beta1A2aTask": { -"description": "An A2aTask represents a unit of work.", -"id": "GoogleCloudAiplatformV1beta1A2aTask", +"GoogleCloudAiplatformV1beta1A2ATaskRecord": { +"description": "An A2ATaskRecord represents an A2ATask (unit of work) persisted in storage.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecord", "properties": { "appId": { "description": "Optional. Agent application which created the task.", @@ -54600,7 +56111,7 @@ false "artifacts": { "description": "Output only. The artifacts produced by the task.", "items": { -"$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact" +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact" }, "readOnly": true, "type": "array" @@ -54615,9 +56126,16 @@ false "readOnly": true, "type": "string" }, +"deleteTime": { +"description": "Output only. The deletion timestamp of the task.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "expireTime": { -"description": "Optional. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `ttl` if set on the request", +"description": "Output only. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `update_time` and the `ttl`.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "generation": { @@ -54629,7 +56147,7 @@ false "history": { "description": "Output only. The history of the task messages.", "items": { -"$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage" +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage" }, "readOnly": true, "type": "array" @@ -54639,61 +56157,32 @@ false "description": "Properties of the object.", "type": "any" }, -"description": "Optional. Arbitrary, user-defined metadata.", +"description": "Optional. A flexible key-value map for protocol extensions to attach custom attributes to core data structures.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", +"description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTaskRecords/{a2a_task_record}`", "type": "string" }, -"nextEventSequenceNumber": { -"description": "Output only. The next event sequence number to be appended to the task. This value starts at 1 and is guaranteed to be monotonically increasing.", -"format": "int64", +"purgeTime": { +"description": "Output only. The purge timestamp of the task.", +"format": "google-datetime", "readOnly": true, "type": "string" }, -"output": { -"$ref": "GoogleCloudAiplatformV1beta1TaskOutput", -"description": "Optional. The final output of the task." +"serviceMetadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"state": { -"description": "Output only. The state of the task. The state of a new task is SUBMITTED by default. The state of a task can only be updated via AppendA2aTaskEvents API.", -"enum": [ -"STATE_UNSPECIFIED", -"SUBMITTED", -"WORKING", -"COMPLETED", -"CANCELLED", -"FAILED", -"REJECTED", -"INPUT_REQUIRED", -"AUTH_REQUIRED", -"PAUSED" -], -"enumDescriptions": [ -"Task state unspecified. Default value if not set.", -"Task is submitted and waiting to be processed.", -"Task is actively being processed.", -"Task is finished.", -"Task is cancelled.", -"Task has failed.", -"Task is rejected by the system.", -"Task requires input from the user.", -"Task requires auth (e.g. OAuth) from the user.", -"Task is paused." -], -"readOnly": true, -"type": "string" +"description": "Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication.", +"type": "object" }, "status": { -"$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatus", +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatus", "description": "Output only. The status of the task, including the state, status message, and timestamp.", "readOnly": true }, -"statusDetails": { -"$ref": "GoogleCloudAiplatformV1beta1TaskStatusDetails", -"description": "Optional. The status details of the task." -}, "ttl": { "description": "Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]", "format": "google-duration", @@ -54712,9 +56201,462 @@ false }, "type": "object" }, -"GoogleCloudAiplatformV1beta1A2aTaskArtifact": { +"GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact": { "description": "Represents a single artifact produced by a task.", -"id": "GoogleCloudAiplatformV1beta1A2aTaskArtifact", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact", +"properties": { +"artifactId": { +"description": "Required. The unique identifier of the artifact within the task.", +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the artifact.", +"type": "string" +}, +"displayName": { +"description": "Optional. The human-readable name of the artifact.", +"type": "string" +}, +"extensions": { +"description": "Optional. A2A protocol extensions associated with the artifact.", +"items": { +"type": "string" +}, +"type": "array" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.", +"type": "object" +}, +"parts": { +"description": "Required. The content parts that make up the artifact.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2APart" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordArtifactChange": { +"description": "An event payload describing a change to one of the task's artifacts.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifactChange", +"properties": { +"append": { +"description": "Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.", +"type": "boolean" +}, +"artifact": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifact", +"description": "Required. The artifact that was added or updated." +}, +"lastChunk": { +"description": "Optional. Whether this is the last chunk of a streamed artifact.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordEvent": { +"description": "An event that records a single change applied to a task's state.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent", +"properties": { +"createTime": { +"description": "Output only. The time at which the event was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"eventData": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordEventData", +"description": "Required. The data describing the change carried by this event." +}, +"generation": { +"description": "Output only. The generation number of the task after this event is applied.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordEventData": { +"description": "The data describing the change carried by an A2ATaskRecordEvent. Multiple changes can be set in a single event.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordEventData", +"properties": { +"artifactChange": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordArtifactChange", +"description": "Optional. A change to one of the task's artifacts." +}, +"historyAppend": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordHistoryAppend", +"description": "Optional. A new message appended to the task history." +}, +"metadataChange": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMetadataChange", +"description": "Optional. A change to the task-level metadata." +}, +"statusUpdate": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatusUpdate", +"description": "Optional. An update to the task's state and status message." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordHistoryAppend": { +"description": "An event payload that appends a new message to the task history.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordHistoryAppend", +"properties": { +"message": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage", +"description": "Required. The message to append to the task history." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordMessage": { +"description": "Represents a single message in a conversation, compliant with the A2A specification.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage", +"properties": { +"extensions": { +"description": "Optional. A2A protocol extensions associated with the message.", +"items": { +"type": "string" +}, +"type": "array" +}, +"messageId": { +"description": "Required. The unique identifier of the message.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.", +"type": "object" +}, +"parts": { +"description": "Required. The content parts that make up the message.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2APart" +}, +"type": "array" +}, +"referenceTaskIds": { +"description": "Optional. The IDs of other tasks referenced by this message.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Required. The role of the sender of the message.", +"enum": [ +"ROLE_UNSPECIFIED", +"USER", +"AGENT" +], +"enumDescriptions": [ +"The role is unspecified.", +"The message is from the client to the server.", +"The message is from the server to the client." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordMetadataChange": { +"description": "An event payload describing a change to the task-level metadata.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordMetadataChange", +"properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. The updated task metadata after the change. This is a partial update that will be merged with the existing metadata.", +"type": "object" +}, +"updateMask": { +"description": "Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordStatus": { +"description": "Represents the status of an A2ATaskRecord.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatus", +"properties": { +"message": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage", +"description": "Output only. The status message associated with the state.", +"readOnly": true +}, +"state": { +"description": "Output only. The current state of the task.", +"enum": [ +"STATE_UNSPECIFIED", +"TASK_STATE_SUBMITTED", +"TASK_STATE_WORKING", +"TASK_STATE_COMPLETED", +"TASK_STATE_FAILED", +"TASK_STATE_CANCELED", +"TASK_STATE_INPUT_REQUIRED", +"TASK_STATE_REJECTED", +"TASK_STATE_AUTH_REQUIRED" +], +"enumDescriptions": [ +"The task is in an unknown or indeterminate state.", +"Indicates that a task has been successfully submitted and acknowledged.", +"Indicates that a task is actively being processed by the agent.", +"Indicates that a task has finished successfully. This is a terminal state.", +"Indicates that a task has finished with an error. This is a terminal state.", +"Indicates that a task was canceled before completion. This is a terminal state.", +"Indicates that the agent requires additional user input to proceed. This is an interrupted state.", +"Indicates 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.", +"Indicates that authentication is required to proceed. This is an interrupted state." +], +"readOnly": true, +"type": "string" +}, +"timestamp": { +"description": "Output only. The time at which the state was set.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2ATaskRecordStatusUpdate": { +"description": "An event payload that updates the task's state and optional status message.", +"id": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatusUpdate", +"properties": { +"message": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage", +"description": "Optional. The status message associated with the state change." +}, +"state": { +"description": "Required. The new state of the task.", +"enum": [ +"STATE_UNSPECIFIED", +"TASK_STATE_SUBMITTED", +"TASK_STATE_WORKING", +"TASK_STATE_COMPLETED", +"TASK_STATE_FAILED", +"TASK_STATE_CANCELED", +"TASK_STATE_INPUT_REQUIRED", +"TASK_STATE_REJECTED", +"TASK_STATE_AUTH_REQUIRED" +], +"enumDescriptions": [ +"The task is in an unknown or indeterminate state.", +"Indicates that a task has been successfully submitted and acknowledged.", +"Indicates that a task is actively being processed by the agent.", +"Indicates that a task has finished successfully. This is a terminal state.", +"Indicates that a task has finished with an error. This is a terminal state.", +"Indicates that a task was canceled before completion. This is a terminal state.", +"Indicates that the agent requires additional user input to proceed. This is an interrupted state.", +"Indicates 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.", +"Indicates that authentication is required to proceed. This is an interrupted state." +], +"type": "string" +}, +"timestamp": { +"description": "Optional. The time at which the status change occurred.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2aPart": { +"description": "A single part of a message or artifact. A part carries exactly one kind of content.", +"id": "GoogleCloudAiplatformV1beta1A2aPart", +"properties": { +"data": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Structured data content.", +"type": "object" +}, +"filename": { +"description": "Optional. The name of the file, when the part represents a file.", +"type": "string" +}, +"mediaType": { +"description": "Optional. The IANA media type of the content, e.g. \"text/plain\" or \"image/png\".", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.", +"type": "object" +}, +"raw": { +"description": "Optional. Raw binary content.", +"format": "byte", +"type": "string" +}, +"text": { +"description": "Optional. Textual content.", +"type": "string" +}, +"url": { +"description": "Optional. A URL pointing to the content.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2aTask": { +"description": "An A2aTask represents a unit of work.", +"id": "GoogleCloudAiplatformV1beta1A2aTask", +"properties": { +"appId": { +"description": "Optional. Agent application which created the task.", +"type": "string" +}, +"artifacts": { +"description": "Output only. The artifacts produced by the task.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact" +}, +"readOnly": true, +"type": "array" +}, +"contextId": { +"description": "Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).", +"type": "string" +}, +"createTime": { +"description": "Output only. The creation timestamp of the task.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"expireTime": { +"description": "Optional. Timestamp of when this task is considered expired. This is *always* provided on output, and is calculated based on the `ttl` if set on the request", +"format": "google-datetime", +"type": "string" +}, +"generation": { +"description": "Output only. The task generation number.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"history": { +"description": "Output only. The history of the task messages.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage" +}, +"readOnly": true, +"type": "array" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Arbitrary, user-defined metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", +"type": "string" +}, +"nextEventSequenceNumber": { +"description": "Output only. The next event sequence number to be appended to the task. This value starts at 1 and is guaranteed to be monotonically increasing.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"output": { +"$ref": "GoogleCloudAiplatformV1beta1TaskOutput", +"description": "Optional. The final output of the task." +}, +"state": { +"description": "Output only. The state of the task. The state of a new task is SUBMITTED by default. The state of a task can only be updated via AppendA2aTaskEvents API.", +"enum": [ +"STATE_UNSPECIFIED", +"SUBMITTED", +"WORKING", +"COMPLETED", +"CANCELLED", +"FAILED", +"REJECTED", +"INPUT_REQUIRED", +"AUTH_REQUIRED", +"PAUSED" +], +"enumDescriptions": [ +"Task state unspecified. Default value if not set.", +"Task is submitted and waiting to be processed.", +"Task is actively being processed.", +"Task is finished.", +"Task is cancelled.", +"Task has failed.", +"Task is rejected by the system.", +"Task requires input from the user.", +"Task requires auth (e.g. OAuth) from the user.", +"Task is paused." +], +"readOnly": true, +"type": "string" +}, +"status": { +"$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatus", +"description": "Output only. The status of the task, including the state, status message, and timestamp.", +"readOnly": true +}, +"statusDetails": { +"$ref": "GoogleCloudAiplatformV1beta1TaskStatusDetails", +"description": "Optional. The status details of the task." +}, +"ttl": { +"description": "Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]", +"format": "google-duration", +"type": "string" +}, +"updateTime": { +"description": "Output only. The last update timestamp of the task.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"userId": { +"description": "Optional. Task owner user ID.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1A2aTaskArtifact": { +"description": "Represents a single artifact produced by a task.", +"id": "GoogleCloudAiplatformV1beta1A2aTaskArtifact", "properties": { "artifactId": { "description": "Required. The unique identifier of the artifact within the task.", @@ -55382,6 +57324,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AgentResponseCustomization": { +"description": "Customizes the agent's response to the end user when a `SemanticGovernancePolicy` is evaluated (for example, with a custom message shown on denial).", +"id": "GoogleCloudAiplatformV1beta1AgentResponseCustomization", +"properties": { +"denialMessage": { +"description": "Optional. Custom message shown to the end user when the policy check results in a denial. Use this to explain the rationale to the user. Max 1000 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1AgentTool": { "description": "A tool provides a list of actions available to the Agent during the process of executing a task.", "id": "GoogleCloudAiplatformV1beta1AgentTool", @@ -55394,15 +57347,15 @@ false "type": "object" }, "name": { -"description": "Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.", +"description": "Optional. The tool's GCP resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`.", "type": "string" }, "type": { -"description": "Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`", +"description": "Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context`", "type": "string" }, "url": { -"description": "Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.", +"description": "Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation.", "type": "string" } }, @@ -55892,6 +57845,37 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsRequest": { +"description": "Request message for A2ATaskRecordService.AppendA2ATaskRecordEvents.", +"id": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsRequest", +"properties": { +"events": { +"description": "Required. The events to append to the task.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent" +}, +"type": "array" +}, +"generation": { +"description": "Required. The current task generation.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsResponse": { +"description": "Response message for A2ATaskRecordService.AppendA2ATaskRecordEvents.", +"id": "GoogleCloudAiplatformV1beta1AppendA2ATaskRecordEventsResponse", +"properties": { +"generation": { +"description": "Task generation matching the last event", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest": { "description": "Request message for AppendA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest", @@ -57556,6 +59540,34 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest": { +"description": "Request message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.", +"id": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentRequest", +"properties": { +"inputs": { +"description": "Required. The inputs to the sandbox environment.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Chunk" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse": { +"description": "Response message for SandboxEnvironmentExecutionService.BidiExecuteSandboxEnvironment.", +"id": "GoogleCloudAiplatformV1beta1BidiExecuteSandboxEnvironmentResponse", +"properties": { +"outputs": { +"description": "The outputs from the sandbox environment.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Chunk" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1BigQueryDestination": { "description": "The BigQuery location for the output content.", "id": "GoogleCloudAiplatformV1beta1BigQueryDestination", @@ -59695,7 +61707,7 @@ false "id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec", "properties": { "codeExecutionRegion": { -"description": "Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED.", +"description": "Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used; requests from regions where the sandbox is unavailable will fail with UNIMPLEMENTED.", "type": "string" }, "evaluationFunction": { @@ -63035,7 +65047,7 @@ false "id": "GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig", "properties": { "codeExecutionRegion": { -"description": "Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: us-central1, us-east1, us-east4, us-west1, us-west4, southamerica-east1, europe-west2, europe-west3, asia-east1, asia-south1, asia-southeast1. If unset, the request's originating region is used.", +"description": "Optional. The region to use for code execution. If set, the Code Execution Sandbox will be invoked in the specified region regardless of the request's originating region. Must be a region where the Code Execution Sandbox is available. Supported regions: northamerica-northeast1, southamerica-east1, us-central1, us-east1, us-east4, us-west1, us-west4, europe-central2, europe-north1, europe-southwest1, europe-west1, europe-west2, europe-west3, europe-west4, europe-west6, europe-west8, europe-west9, me-west1, asia-east1, asia-east2, asia-northeast1, asia-northeast3, asia-south1, asia-south2, asia-southeast1, australia-southeast2. If unset, the request's originating region is used.", "type": "string" }, "parsingFunction": { @@ -69018,6 +71030,10 @@ false "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" +}, +"translationConfig": { +"$ref": "GoogleCloudAiplatformV1beta1TranslationConfig", +"description": "Optional. Config for translation." } }, "type": "object" @@ -71382,6 +73398,42 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListA2ATaskRecordEventsResponse": { +"description": "Response message for A2ATaskRecordService.ListA2ATaskRecordEvents.", +"id": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordEventsResponse", +"properties": { +"events": { +"description": "List of A2ATaskRecordEvents in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordEvent" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ListA2ATaskRecordsResponse": { +"description": "Response message for A2ATaskRecordService.ListA2ATaskRecords.", +"id": "GoogleCloudAiplatformV1beta1ListA2ATaskRecordsResponse", +"properties": { +"a2aTaskRecords": { +"description": "List of A2ATaskRecords in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecord" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as A2ATaskRecordService.ListA2ATaskRecordsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse": { "description": "Response message for ListA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse", @@ -78801,7 +80853,7 @@ false "AGENTIC" ], "enumDescriptions": [ -"Default. Uses model-specific processing (3.5 Pro+ -> `AGENTIC`, older models -> `STATIC`).", +"Defaults to model-specific processing.", "Fixed-rate frame extraction. All frames placed in context.", "Model-driven dynamic navigation. Recommended for most use cases." ], @@ -85500,6 +87552,9 @@ false "STATE_DEPROVISIONING", "STATE_TERMINATED", "STATE_DELETED", +"STATE_PAUSED", +"STATE_PAUSING", +"STATE_RESUMING", "STATE_STOPPING" ], "enumDescriptions": [ @@ -85509,6 +87564,9 @@ false "Sandbox runtime is halted, performing tear down tasks.", "Sandbox has terminated with underlying runtime failure.", "Sandbox runtime has been deleted.", +"Sandbox runtime is paused.", +"Sandbox runtime is pausing.", +"Sandbox runtime is resuming.", "Sandbox runtime is stopping." ], "readOnly": true, @@ -85626,6 +87684,11 @@ false "format": "google-datetime", "readOnly": true, "type": "string" +}, +"useGkeTd": { +"description": "Output only. Whether the source SandboxEnvironment uses the GKE TD pool.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -85645,6 +87708,10 @@ false "shellEnvironment": { "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpecShellEnvironment", "description": "Optional. The shell environment for executing shell commands and scripts." +}, +"useGkeTd": { +"description": "Optional. Immutable. Whether to provision the SandboxEnvironment via the GKE TD pool. Immutable.", +"type": "boolean" } }, "type": "object" @@ -85754,6 +87821,10 @@ false "format": "google-datetime", "readOnly": true, "type": "string" +}, +"useGkeTd": { +"description": "Optional. Immutable. Whether to provision the SandboxEnvironmentTemplate via the GKE TD pool.", +"type": "boolean" } }, "type": "object" @@ -91006,6 +93077,10 @@ false "readOnly": true, "type": "string" }, +"agentResponseCustomization": { +"$ref": "GoogleCloudAiplatformV1beta1AgentResponseCustomization", +"description": "Optional. Settings for customizing the agent's response to end users when this policy is evaluated, such as messages displayed when the policy denies a request." +}, "createTime": { "description": "Output only. Timestamp when this SemanticGovernancePolicy was created.", "format": "google-datetime", @@ -95341,6 +97416,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1TranslationConfig": { +"description": "Config for translation features.", +"id": "GoogleCloudAiplatformV1beta1TranslationConfig", +"properties": { +"echoTargetLanguage": { +"description": "Optional. If `true`, the model will generate audio when the target language is spoken, essentially it will parrot the input. If `false`, we will not produce audio for the target language.", +"type": "boolean" +}, +"targetLanguageCode": { +"description": "Required. The target language for translation. Supported values are BCP-47 language codes (e.g. \"en\", \"es\", \"fr\").", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Trial": { "description": "A message representing a Trial. A Trial contains a unique set of Parameters that has been or will be evaluated, along with the objective metrics got by running the Trial.", "id": "GoogleCloudAiplatformV1beta1Trial", diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 907936898c..01e38561e9 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -1317,7 +1317,7 @@ } } }, -"revision": "20260819", +"revision": "20260829", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1376,7 +1376,7 @@ "type": "string" }, "principal": { -"description": "Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example deleted users.", +"description": "Optional. Represents the principal for this assignment. If not empty, jobs run by this principal utilize the associated reservation. Otherwise, jobs fall back to using the reservation assigned to the project, folder, or organization, in that order. If no reservation is assigned at any of these levels, on-demand capacity is used. The supported formats are: * `principal://goog/subject/USER_EMAIL_ADDRESS` for users, * `principal://iam.googleapis.com/projects/-/serviceAccounts/SA_EMAIL_ADDRESS` for service accounts, * `principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_ID` for workload identity pool identities. * The special value `unknown_or_deleted_user` represents principals which cannot be read from the user info service, for example, deleted users.", "type": "string" }, "schedulingPolicy": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4bf1b1b861..3e0f306607 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -448,7 +448,7 @@ "parameterOrder": [], "parameters": { "requestId": { -"description": "Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.", +"description": "Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.", "location": "query", "type": "string" } @@ -1116,7 +1116,7 @@ "type": "string" }, "requestId": { -"description": "Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message.", +"description": "Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single message being created. Subsequent requests with the same request ID return the existing message and do not update the message, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a message was already created with the provided request ID, the request returns that message. Note that the returned message might not be fully populated; the API echoes the message in your request with the system-assigned resource names populated. To retrieve the latest metadata for the message, call `GetMessage`. - Reusing an existing request ID with a different authenticated user results in an error.", "location": "query", "type": "string" }, @@ -2181,7 +2181,7 @@ } } }, -"revision": "20260820", +"revision": "20260828", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessPermissionSetting": { @@ -6387,7 +6387,7 @@ "type": "array" }, "requestId": { -"description": "Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.", +"description": "Optional. A unique ID for this request. A random UUID is recommended. Specifying a request ID makes the request idempotent, which ensures that multiple identical requests with the same request ID result in only a single space being created. Subsequent requests with the same request ID return the existing space and do not update the space, even if the requested details differ from the current state. To use this field effectively: - Ensure that subsequent requests are identical and use the same authentication credentials as the original request. - If a space was already created with the provided request ID, the request returns that space. Note that the returned space might not be fully populated; the API echoes the space in your request with the system-assigned resource name populated. To retrieve the latest metadata for the space, call `GetSpace`. - Reusing an existing request ID with a different authenticated user results in an error.", "type": "string" }, "space": { diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 36921a9986..a5f7c7c33c 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -1308,7 +1308,7 @@ ] }, "delete": { -"description": "Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone. Note: the key ring and its metadata will be remembered by KeyManagementService to prevent re-use of the key ring's resource name.", +"description": "Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}", "httpMethod": "DELETE", "id": "cloudkms.projects.locations.keyRings.delete", @@ -3089,7 +3089,7 @@ } } }, -"revision": "20260821", +"revision": "20260827", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AddQuorumMember": { diff --git a/googleapiclient/discovery_cache/documents/curationpartners.v1.json b/googleapiclient/discovery_cache/documents/curationpartners.v1.json index a725f56b1b..ef28524cc0 100644 --- a/googleapiclient/discovery_cache/documents/curationpartners.v1.json +++ b/googleapiclient/discovery_cache/documents/curationpartners.v1.json @@ -784,7 +784,7 @@ } } }, -"revision": "20260828", +"revision": "20260901", "rootUrl": "https://curationpartners.googleapis.com/", "schemas": { "AccessControlSettings": { @@ -1265,7 +1265,7 @@ "Bids in auction.", "Bid requests.", "Clicks.", -"Curator fee.", +"Curator fee. This will be redacted to 0.00 if the package's visibility is set to non-disclosed. Use the PACKAGE_FEE_VISIBILITY dimension to check if the package's fee is disclosed.", "Number of data segment requests sent in the Real-time curation.", "Impressions.", "Spend in reporting currency specified in the request. Defaults to USD." @@ -2090,7 +2090,7 @@ "Bids in auction.", "Bid requests.", "Clicks.", -"Curator fee.", +"Curator fee. This will be redacted to 0.00 if the package's visibility is set to non-disclosed. Use the PACKAGE_FEE_VISIBILITY dimension to check if the package's fee is disclosed.", "Number of data segment requests sent in the Real-time curation.", "Impressions.", "Spend in reporting currency specified in the request. Defaults to USD." diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index 7923ef089a..8ad80bc402 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -211,7 +211,7 @@ ], "parameters": { "filter": { -"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`", +"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` - `partner_link_metadata.implicit_accounts.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`", "location": "query", "type": "string" }, @@ -860,7 +860,7 @@ } } }, -"revision": "20260824", +"revision": "20260828", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdEvent": { diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json index 7d578fc53d..e1423e2d41 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json @@ -250,7 +250,7 @@ } } }, -"revision": "20260823", +"revision": "20260830", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "Answer": { @@ -413,7 +413,7 @@ "type": "string" }, "uri": { -"description": "Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.", +"description": "Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json index 4deedfae74..1b4535d443 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json @@ -250,7 +250,7 @@ } } }, -"revision": "20260809", +"revision": "20260830", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "Answer": { @@ -413,7 +413,7 @@ "type": "string" }, "uri": { -"description": "Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.", +"description": "Output only. Provides the URI of the content, such as `https://docs.cloud.google.com/storage/docs/creating-buckets`.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index da3326e1b4..11831dfeb1 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -7823,7 +7823,7 @@ } } }, -"revision": "20260811", +"revision": "20260902", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -11975,7 +11975,7 @@ false "id": "DigitalContentLabelAssignedTargetingOptionDetails", "properties": { "excludedContentRatingTier": { -"description": "Required. The display name of the digital content label rating tier to be EXCLUDED.", +"description": "Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.**", "enum": [ "CONTENT_RATING_TIER_UNSPECIFIED", "CONTENT_RATING_TIER_UNRATED", @@ -11986,13 +11986,13 @@ false "CONTENT_RATING_TIER_FAMILIES" ], "enumDescriptions": [ -"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "Content that has not been labeled.", -"Content suitable for general audiences.", -"Content suitable for most audiences with parental guidance.", -"Content suitable for teen and older audiences.", -"Content suitable only for mature audiences.", -"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +"Content suitable for general audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for most audiences with parental guidance. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for teen and older audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable only for mature audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**" ], "type": "string" } @@ -12015,13 +12015,13 @@ false "CONTENT_RATING_TIER_FAMILIES" ], "enumDescriptions": [ -"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "Content that has not been labeled.", -"Content suitable for general audiences.", -"Content suitable for most audiences with parental guidance.", -"Content suitable for teen and older audiences.", -"Content suitable only for mature audiences.", -"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +"Content suitable for general audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for most audiences with parental guidance. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for teen and older audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable only for mature audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**" ], "readOnly": true, "type": "string" @@ -17899,7 +17899,7 @@ false "id": "SensitiveCategoryAssignedTargetingOptionDetails", "properties": { "excludedSensitiveCategory": { -"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.", +"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.**", "enum": [ "SENSITIVE_CATEGORY_UNSPECIFIED", "SENSITIVE_CATEGORY_ADULT", @@ -17924,23 +17924,23 @@ false ], "enumDescriptions": [ "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", -"Adult or pornographic text, image, or video content.", -"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", -"Content related to audio, video, or software downloads.", -"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", -"Contains content related to betting or wagering in a real-world or online setting.", -"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", -"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", -"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", -"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", -"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", -"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", -"Political news and media, including discussions of social, governmental, and public policy.", -"Content related to religious thought or beliefs.", -"Content related to death, disasters, accidents, war, etc.", -"Content related to motor vehicle, aviation or other transportation accidents.", -"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", -"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"Adult or pornographic text, image, or video content. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to audio, video, or software downloads. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to betting or wagering in a real-world or online setting. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Political news and media, including discussions of social, governmental, and public policy. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to religious thought or beliefs. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to death, disasters, accidents, war, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to motor vehicle, aviation or other transportation accidents. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States). **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "YouTube videos embedded on websites outside of YouTube.com.", "Video of live events streamed over the internet." ], @@ -17979,23 +17979,23 @@ false ], "enumDescriptions": [ "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", -"Adult or pornographic text, image, or video content.", -"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", -"Content related to audio, video, or software downloads.", -"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", -"Contains content related to betting or wagering in a real-world or online setting.", -"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", -"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", -"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", -"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", -"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", -"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", -"Political news and media, including discussions of social, governmental, and public policy.", -"Content related to religious thought or beliefs.", -"Content related to death, disasters, accidents, war, etc.", -"Content related to motor vehicle, aviation or other transportation accidents.", -"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", -"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"Adult or pornographic text, image, or video content. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to audio, video, or software downloads. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to betting or wagering in a real-world or online setting. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Political news and media, including discussions of social, governmental, and public policy. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to religious thought or beliefs. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to death, disasters, accidents, war, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to motor vehicle, aviation or other transportation accidents. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States). **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "YouTube videos embedded on websites outside of YouTube.com.", "Video of live events streamed over the internet." ], diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index acbfee2f3f..610e665c31 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -8360,7 +8360,7 @@ } } }, -"revision": "20260811", +"revision": "20260902", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8576,7 +8576,7 @@ "type": "object" }, "AdGroupAd": { -"description": "A single ad associated with an ad group.", +"description": "LINT: LEGACY_NAMES A single ad associated with an ad group.", "id": "AdGroupAd", "properties": { "adGroupAdId": { @@ -15016,7 +15016,7 @@ false "id": "DigitalContentLabelAssignedTargetingOptionDetails", "properties": { "excludedContentRatingTier": { -"description": "Required. The display name of the digital content label rating tier to be EXCLUDED.", +"description": "Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.**", "enum": [ "CONTENT_RATING_TIER_UNSPECIFIED", "CONTENT_RATING_TIER_UNRATED", @@ -15027,13 +15027,13 @@ false "CONTENT_RATING_TIER_FAMILIES" ], "enumDescriptions": [ -"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "Content that has not been labeled.", -"Content suitable for general audiences.", -"Content suitable for most audiences with parental guidance.", -"Content suitable for teen and older audiences.", -"Content suitable only for mature audiences.", -"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +"Content suitable for general audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for most audiences with parental guidance. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for teen and older audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable only for mature audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**" ], "type": "string" } @@ -15056,13 +15056,13 @@ false "CONTENT_RATING_TIER_FAMILIES" ], "enumDescriptions": [ -"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "Content that has not been labeled.", -"Content suitable for general audiences.", -"Content suitable for most audiences with parental guidance.", -"Content suitable for teen and older audiences.", -"Content suitable only for mature audiences.", -"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +"Content suitable for general audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for most audiences with parental guidance. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for teen and older audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable only for mature audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**" ], "readOnly": true, "type": "string" @@ -21163,7 +21163,7 @@ false "id": "SensitiveCategoryAssignedTargetingOptionDetails", "properties": { "excludedSensitiveCategory": { -"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.", +"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.**", "enum": [ "SENSITIVE_CATEGORY_UNSPECIFIED", "SENSITIVE_CATEGORY_ADULT", @@ -21188,23 +21188,23 @@ false ], "enumDescriptions": [ "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", -"Adult or pornographic text, image, or video content.", -"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", -"Content related to audio, video, or software downloads.", -"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", -"Contains content related to betting or wagering in a real-world or online setting.", -"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", -"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", -"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", -"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", -"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", -"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", -"Political news and media, including discussions of social, governmental, and public policy.", -"Content related to religious thought or beliefs.", -"Content related to death, disasters, accidents, war, etc.", -"Content related to motor vehicle, aviation or other transportation accidents.", -"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", -"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"Adult or pornographic text, image, or video content. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to audio, video, or software downloads. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to betting or wagering in a real-world or online setting. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Political news and media, including discussions of social, governmental, and public policy. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to religious thought or beliefs. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to death, disasters, accidents, war, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to motor vehicle, aviation or other transportation accidents. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States). **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "YouTube videos embedded on websites outside of YouTube.com.", "Video of live events streamed over the internet." ], @@ -21243,23 +21243,23 @@ false ], "enumDescriptions": [ "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", -"Adult or pornographic text, image, or video content.", -"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", -"Content related to audio, video, or software downloads.", -"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", -"Contains content related to betting or wagering in a real-world or online setting.", -"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", -"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", -"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", -"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", -"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", -"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", -"Political news and media, including discussions of social, governmental, and public policy.", -"Content related to religious thought or beliefs.", -"Content related to death, disasters, accidents, war, etc.", -"Content related to motor vehicle, aviation or other transportation accidents.", -"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", -"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"Adult or pornographic text, image, or video content. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to audio, video, or software downloads. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to betting or wagering in a real-world or online setting. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Political news and media, including discussions of social, governmental, and public policy. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to religious thought or beliefs. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to death, disasters, accidents, war, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to motor vehicle, aviation or other transportation accidents. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States). **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "YouTube videos embedded on websites outside of YouTube.com.", "Video of live events streamed over the internet." ], diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 6815b73bc7..6a8d84655b 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -9618,7 +9618,7 @@ } } }, -"revision": "20260811", +"revision": "20260902", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9904,7 +9904,7 @@ "type": "object" }, "AdGroupAd": { -"description": "A single ad associated with an ad group.", +"description": "LINT: LEGACY_NAMES A single ad associated with an ad group.", "id": "AdGroupAd", "properties": { "adGroupAdId": { @@ -16729,7 +16729,7 @@ false "id": "DigitalContentLabelAssignedTargetingOptionDetails", "properties": { "excludedContentRatingTier": { -"description": "Required. The display name of the digital content label rating tier to be EXCLUDED.", +"description": "Required. The display name of the digital content label rating tier to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept the value `CONTENT_RATING_TIER_UNRATED`. All other values will be deprecated and no longer be accepted.**", "enum": [ "CONTENT_RATING_TIER_UNSPECIFIED", "CONTENT_RATING_TIER_UNRATED", @@ -16740,13 +16740,13 @@ false "CONTENT_RATING_TIER_FAMILIES" ], "enumDescriptions": [ -"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "Content that has not been labeled.", -"Content suitable for general audiences.", -"Content suitable for most audiences with parental guidance.", -"Content suitable for teen and older audiences.", -"Content suitable only for mature audiences.", -"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +"Content suitable for general audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for most audiences with parental guidance. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for teen and older audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable only for mature audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**" ], "type": "string" } @@ -16769,13 +16769,13 @@ false "CONTENT_RATING_TIER_FAMILIES" ], "enumDescriptions": [ -"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating.", +"Content label is not specified in this version. This enum is a place holder for a default value and does not represent a real content rating. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "Content that has not been labeled.", -"Content suitable for general audiences.", -"Content suitable for most audiences with parental guidance.", -"Content suitable for teen and older audiences.", -"Content suitable only for mature audiences.", -"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items." +"Content suitable for general audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for most audiences with parental guidance. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for teen and older audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable only for mature audiences. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content suitable for family audiences. It is a subset of CONTENT_RATING_TIER_GENERAL. Only applicable to YouTube and Partners line items. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**" ], "readOnly": true, "type": "string" @@ -24441,7 +24441,7 @@ false "id": "SensitiveCategoryAssignedTargetingOptionDetails", "properties": { "excludedSensitiveCategory": { -"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.", +"description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. **Starting on *October 1, 2026*, this field will only accept `SENSITIVE_CATEGORY_EMBEDDED_VIDEO` or `SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO`. All other values will be deprecated and no longer be accepted.**", "enum": [ "SENSITIVE_CATEGORY_UNSPECIFIED", "SENSITIVE_CATEGORY_ADULT", @@ -24466,23 +24466,23 @@ false ], "enumDescriptions": [ "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", -"Adult or pornographic text, image, or video content.", -"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", -"Content related to audio, video, or software downloads.", -"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", -"Contains content related to betting or wagering in a real-world or online setting.", -"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", -"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", -"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", -"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", -"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", -"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", -"Political news and media, including discussions of social, governmental, and public policy.", -"Content related to religious thought or beliefs.", -"Content related to death, disasters, accidents, war, etc.", -"Content related to motor vehicle, aviation or other transportation accidents.", -"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", -"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"Adult or pornographic text, image, or video content. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to audio, video, or software downloads. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to betting or wagering in a real-world or online setting. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Political news and media, including discussions of social, governmental, and public policy. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to religious thought or beliefs. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to death, disasters, accidents, war, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to motor vehicle, aviation or other transportation accidents. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States). **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "YouTube videos embedded on websites outside of YouTube.com.", "Video of live events streamed over the internet." ], @@ -24521,23 +24521,23 @@ false ], "enumDescriptions": [ "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", -"Adult or pornographic text, image, or video content.", -"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", -"Content related to audio, video, or software downloads.", -"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", -"Contains content related to betting or wagering in a real-world or online setting.", -"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", -"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", -"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", -"Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", -"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", -"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", -"Political news and media, including discussions of social, governmental, and public policy.", -"Content related to religious thought or beliefs.", -"Content related to death, disasters, accidents, war, etc.", -"Content related to motor vehicle, aviation or other transportation accidents.", -"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", -"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", +"Adult or pornographic text, image, or video content. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to audio, video, or software downloads. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to betting or wagering in a real-world or online setting. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to alcoholic beverages, alcohol brands, recipes, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Political news and media, including discussions of social, governmental, and public policy. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to religious thought or beliefs. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to death, disasters, accidents, war, etc. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content related to motor vehicle, aviation or other transportation accidents. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States). **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", +"Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor. **Starting on *October 1, 2026*, this value will be deprecated and no longer be accepted as a valid value when assigning targeting.**", "YouTube videos embedded on websites outside of YouTube.com.", "Video of live events streamed over the internet." ], diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 82440413bf..652b223c46 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -184,7 +184,7 @@ "type": "string" }, "includeTabsContent": { -"description": "Whether to populate the Document.tabs field instead of the text content fields like `body` and `documentStyle` on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.", +"description": "Whether to populate the `Document.tabs` field instead of the text content fields like `body` and `documentStyle` on `Document`. - When `true`: Document content populates in the `Document.tabs` field instead of the text content fields in `Document`. - When `false`: The content of the document's first tab populates the content fields in `Document` excluding `Document.tabs`. If a document has only one tab, then that tab is used to populate the document content. `Document.tabs` will be empty. If you use a field mask that references the `Document.tabs` field (or any subfield), the API implicitly treats the request as if you set `include_tabs_content` to `true`.", "location": "query", "type": "boolean" }, @@ -221,7 +221,7 @@ } } }, -"revision": "20260427", +"revision": "20260901", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AddDocumentTabRequest": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index bfa95a0615..44503fc6d9 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -2602,7 +2602,7 @@ } } }, -"revision": "20260818", +"revision": "20260826", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -4900,7 +4900,7 @@ "id": "GoogleFirestoreAdminV1SearchGeoSpec", "properties": { "geoJsonIndexingDisabled": { -"description": "Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed.", +"description": "Optional. Disables geoJSON indexing for the field. By default, geoJSON points are indexed. Firestore GeoPoints are indexed regardless of the value of this field.", "type": "boolean" } },